magwo / node-geo-tz

A node.js module to find the timezone based on gps coordinates

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

node-geo-tz

npm version Build Status Dependency Status Test Coverage

A node.js module to find the timezone at specific gps coordinates

Install

npm install geo-tz

Usage

var geoTz = require('geo-tz')

var name        = geoTz.tz(47.650499, -122.350070)                                // 'America/Los_Angeles'
var now         = geoTz.tzMoment(47.650499, -122.350070)                          // moment-timezone obj
var specifcTime = geoTz.tzMoment(47.650499, -122.350070, '2016-03-30T01:23:45Z')  // moment-timezone obj

API Docs:

.tz(lat, lon)

Returns timezone name found at lat, lon. Returns null if timezone could not be found at coordinate.

.tzMoment(lat, lon, [dateTime])

Returns a moment-timezone object found at lat, lon. Returns null if timezone could not be found at coordinate. If dateTime is omitted, the moment-timezone will have the current time set. If dateTime is provided, moment-timezone will be set to the time provided according to the timezone found. dateTime can be any single-argument parameter that will get passed to the moment() parser.

An Important Note About Maintenance

Due to the ever-changing nature of timezone data, it is critical that you always use the latest version of this package. Any releases to this project's dependency of moment-timezone will also cause a new release in this package. If you use old versions, there will be a few edge cases where the calculated time is wrong. If you use greenkeeper, please be sure to specify an exact target version so you will always get PR's for even patch-level releases.

About

A node.js module to find the timezone based on gps coordinates

License:MIT License


Languages

Language:JavaScript 100.0%