tz

package module
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2024 License: MIT Imports: 1 Imported by: 2

README

Package tz

Project status Build Status Go Report Card GoDoc License

Package tz contains Timezone Country and Zone data generated from timezonedb.com

This library is nothing special, it contains alphabetically sorted Country and Zone info that can be used within your project.

Motivation

I got tired of rewriting this, or using a db, to store this information just so I can add to an HTML dropdown for selection. So in short here it is for use and hope it saves someone else some time as well.

NOTES

This is intended to be used along side Go's own time logic eg. time.LoadLocation

Example using with

countries := tz.GetCountries()

// display to user for selection
// once selected load the zones

country := tz.GetCountry(countryCode)

// display zone options to user with country.Zones
// once selected by user use it in your application

zone := country zone, selected by user, gathered from posted data, or retrieved from db ( stored on user )...

loc, _ := time.LoadLocation(zone)

// now that you have location can use with Go's time package which handles timezone offsets & Daylight savings times.

time.ParseInLocation(...)
time.Now().In(loc)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Country

type Country struct {
	Code  string
	Name  string
	Zones []Zone
}

Country contains a single Country's information

func GetCountries

func GetCountries() []Country

GetCountries returns an array of all countries. Most common use: for loading into a country dropdown in HTML.

func GetCountry

func GetCountry(code string) (c Country, found bool)

GetCountry returns a single Country that matches the country code passed and whether it was found

type Zone

type Zone struct {
	CountryCode string
	Name        string
}

Zone contains a single Country's Zone information

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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