Skip to content
This repository has been archived by the owner on May 4, 2021. It is now read-only.

Latest commit

 

History

History
61 lines (44 loc) · 1.2 KB

readme.md

File metadata and controls

61 lines (44 loc) · 1.2 KB

us-timezone-names

Library to get us timezone details. Functions accept timezone names and abbreviations

Functions

getTimeZoneByName

Get timezone info object by timezone name.

 import tz from 'us-timezones-name';

 tz.getTimeZoneByName( 'Pacific Standard Time' );
 // Returns
 {
   Abbreviation: 'PST',  //Abbreviation for the timezone
   Name: 'Pacific Standard Time',  //Standard Name
   DisplayName: 'Pacific Standard Time(UTC - 8)',  //Display String
   Offset: '-8 hours' //Offset string
 }

getTimeZoneByAbbreviation

Get timezone info object by timezone abbreviation.

 tz.getTimeZoneByAbbreviation( 'PST' );
 // Returns
 {
   Abbreviation: 'PST',  //Abbreviation for the timezone
   Name: 'Pacific Standard Time',  //Standard Name
   DisplayName: 'Pacific Standard Time(UTC - 8)',  //Display String
   Offset: '-8 hours' //Offset string
 }

getAll

Get all timezones objects.

 tz.getAll();
 // Returns  Array of timezone objects
 [
 {
   Abbreviation: 'PST',  //Abbreviation for the timezone
   Name: 'Pacific Standard Time',  //Standard Name
   DisplayName: 'Pacific Standard Time(UTC - 8)',  //Display String
   Offset: '-8 hours' //Offset string
 },
 .
 .
 ]