Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 3.4 KB

README.md

File metadata and controls

85 lines (67 loc) · 3.4 KB

node-timezone

Build Status

Node.js client library for accessing Google Time Zone API. It provides time offset data for locations on the surface of the earth. Requesting the time zone information for a specific Latitude/Longitude pair will return the name of that time zone, the time offset from UTC, and the Daylight Savings offset.

Installation

$ npm install timezoner 

Usage

    var timezoner = require('timezoner');
	/* Request timezone with location coordinates */
	timezoner.getTimeZone(
		39.6034810, // Latitude coordinate
		-119.6822510, // Longitude coordinate
		function (err, data) {
			if (err) {
				console.log(err);
			} else {
				console.log(data);
			}
		}
	);
Response data:
{
   "dstOffset" : 0.0,
   "rawOffset" : -28800.0,
   "status" : "OK",
   "timeZoneId" : "America/Los_Angeles",
   "timeZoneName" : "Pacific Standard Time"
}

You can pass in an optional options as a last argument, it can be useful to pass Optional Parameters like key and language. The language parameter is used to the language in which to return results and key parameter is the API Key which identifies your application for purposes of quota management. Please see API Key to know more about key parameter.

	timezoner.getTimeZone(
		39.6034810,
		-119.6822510,
		function (err, data) {
			if (err) {
				console.log(err);
			} else {
				console.log(data);
			}
		},
		{ language: 'es', key: 'YOUR_API_KEY' }
	);

The response will now be localized to Spanish.

{
   "dstOffset" : 3600.0,
   "rawOffset" : -28800.0,
   "status" : "OK",
   "timeZoneId" : "America/Los_Angeles",
   "timeZoneName" : "Hora de verano del Pacífico"
}

You can find more details about response and different status of response from Time Zone Responses.

Notes

Removed the sensor parameter in options. It is no longer required by Google Time Zone API.

License

The MIT License (MIT)

Copyright (c) 2013-2018 Justin John Mathews [email protected]

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.