timezones

README

Timezones for Go

go get github.com/JasperLabs/go-timezones

Available on GoDoc at godoc.org/github.com/JasperLabs/go-timezones.

Provides a Go application with an array of timezones (sourced from dmfilipenko/timezones.json) as package timezones.

Usage

Access TimeZone struct via timezones.TimeZone

type TimeZone struct {
	Value  string   `json:"value"`  // Dateline Standard Time
	Abbr   string   `json:"abbr"`   // DST
	Offset int      `json:"offset"` // -12
	Isdst  bool     `json:"isdst"`  // false
	Text   string   `json:"text"`   // (UTC-12:00) International Date Line West
	Utc    []string `json:"utc"`    // ["Etc/GMT+12"]
}

Get an array of TimeZones.

timezones := GetTimeZones()
	
for _, tz := range timezones {
	log.Printf("%v (%v)", tz.Text, tz.Offset)
}

Get a specific TimeZone by Value.

var offset string
tz, err := timezones.GetTimeZoneByValue(req.TimeZone)
if err == timezones.TimeZoneNotFound {
	return nil, err
}
offset = tz.Offset

Contributing

Pull requests with tests are welcome and will be reviewed in a timely manner (24-hour window).

License

The MIT License (MIT)

Copyright (c) 2019 Jasper Property Limited

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package timezones provides an array of timezones as well as a simple API for accessing and searching timezones.

Index

• Variables
• type TimeZone
  • func GetTimeZoneByValue(value string) (*TimeZone, error)
  • func GetTimeZones() []TimeZone

Variables

var TimeZoneNotFound = errors.New("timezone not found")

Types

type TimeZone

type TimeZone struct {
	Value  string   `json:"value"`
	Abbr   string   `json:"abbr"`
	Offset int      `json:"offset"`
	Isdst  bool     `json:"isdst"`
	Text   string   `json:"text"`
	Utc    []string `json:"utc"`
}

TimeZone represents an international date/time zone.

func GetTimeZoneByValue

func GetTimeZoneByValue(value string) (*TimeZone, error)

GetTimeZoneByValue returns a TimeZone by the Value field.

func GetTimeZones

func GetTimeZones() []TimeZone

GetTimeZones returns an array of TimeZone.