kair

package module
v0.0.0-...-2cbc3ec Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 18, 2020 License: MIT Imports: 3 Imported by: 0

README

Kair

Date and Time - Golang Formatting Library

Mentioned in Awesome Go Go Report Card codecov Build Status GitHub GoDoc

Setup

To get Kair

> Go CLI
go get github.com/GuilhermeCaruso/kair
> Go DEP
dep ensure -add github.com/GuilhermeCaruso/kair
> Govendor
govendor fetch github.com/GuilhermeCaruso/kair

Example

package main

import (
	"fmt"

	k "github.com/GuilhermeCaruso/kair"
)

func main() {
	now := k.Now()

    fmt.Printf("Right now is %s \n", now.CustomFormat("dd/MM/YYYY hh:mm:ss"))

	date := k.Date(29, 05, 1980)

	fmt.Printf("The %s was a %s in %s\n",
		date.Format("L"),
		date.CustomFormat("DD"),
        date.CustomFormat("MMMM")) //The 29/05/1980 was a Thursday in May 
}

Formatters

  • Standard
    "LT":   10:20 AM,
    "LTS":  10:20:00 AM,
    "L":    20/05/2018,
    "l":    20/5/2018,
    "LL":   May 20, 2018,
    "ll":   May 20, 2018,
    "LLL":  May 20, 2018 10:20 AM,
    "lll":  May 20, 2018 10:20 AM,
    "LLLL": Sunday, May 20, 2018 10:20 AM,
    "llll": Sun, May 20, 2018 10:20 AM,
    "":     2018-05-20 10:20:00 +0000 UTC,
  • Custom
    "MMMM": Long Month,
    "MMM":  Month,
    "MM":   Zero Number Month,
    "M":    Number Month,
    "YYYY": Long Year,
    "YY":   Year,
    "DD":   Long Day,
    "D":    Day,
    "dd":   Long Number Day,
    "d":    Number Day,
    "hh":   Long Hour,
    "h":    Hour,
    "mm":   Long Minute,
    "m":    Minute,
    "ss":   Long Second,
    "s":    Second

Contributing

Please feel free to make suggestions, create issues, fork the repository and send pull requests!

To do:

  • Implement Standard Format
  • Implement Custom Format
  • Implement Now(), Date() and DateTime() initializers
  • Implement Relative Time (FromNow, StartOf ...)
  • Implement CalendarTime (add, subtract, calendar)

License

MIT License © Guilherme Caruso

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type SKair

type SKair struct {
	Time time.Time
}

SKair Used to standardize the use of functions

func Date

func Date(day int, month int, year int) *SKair

Date - Retrieves a custom date

func DateTime

func DateTime(day int, month int, year int, hour int, min int, sec int) *SKair

DateTime - Retrieves a custom datetime

func Now

func Now() *SKair

Now - Retrieve current datetime

func (*SKair) CustomFormat

func (k *SKair) CustomFormat(pformat string) string

CustomFormat Uses custom sequence for the time format.

Returns a string custom datetime format

Custom formatters :

"MMMM": Long Month,
"MMM":  Month,
"MM":   Zero Number Month,
"M":    Number Month,
"YYYY": Long Year,
"YY":   Year,
"DD":   Long Day,
"D":    Day,
"dd":  	Long Number Day,
"d":    Number Day,
"hh":   Long Hour,
"h":   	Hour,
"mm":   Long Minute,
"m":    Minute,
"ss":   Long Second,
"s":    Second

func (*SKair) Format

func (k *SKair) Format(format string) string

Format Uses standard sequence for the time format. Returns a string standart format if var is invalid

Standard formats :

["LT", "LTS", "L", "l", "LL", "ll", "LLL", "lll", "LLLL", "llll"]

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL