Giter Club home page Giter Club logo

walltime-js's Introduction

walltime-js Build Status

Walltime-js is a JavaScript library for easily translating a UTC time to a "Wall Time" for a particular time zone.

Problems this solves

Dates in JavaScript do not properly account for daylight savings time for regions other than your own browser configured time zone.

For example:

  • Your API sends UTC times in JSON but you need to display them for Chicago time zone to a user viewing your page in Los Angeles.
  • What was the UTC Time on May 24, 1844 at 9:00 AM in Baltimore, Maryland?

Usage

<script src="/path/to/walltime-data.js"></script>
<script src="/path/to/walltime.js"></script>
<script type="text/javascript">
    var someUTCDate = new Date(new Date().getTime()),
        chicagoWallTime = WallTime.UTCToWallTime(someUTCDate, "America/Chicago");
</script>

Building Data

To limit the size of WallTime.js, you should only use the data for the time zone files you need.

By default, walltime-data.js contains northamerica, europe and australasia, which encompass most of the world, but is 479k (minified). By narrowing it down to just northamerica, you could save 300k. Adding gzip compression could get you down as low as 16k.

This project uses Node.js and CoffeeScript; go and install them if you don't have them.

To get the latest Olson files

git submodule init && git submodule update

To build all the data for all the time zone files

cake data

To build data for northamerica only

cake -f northamerica data

To build data for northamerica and europe

cake -f northamerica -f europe data

To build data for America/Chicago only

cake -f northamerica -z America/Chicago data

To build individual data files for each time zone

cake individual

By default the files are saved to ./client/walltime.js etc.

Development

To get setup

# Clone the repo
git clone https://github.com/sproutsocial/walltime-js.git
# Install the dependencies
npm install

To run tests

cake test

To make new tests, create a new spec coffee file in the test directory.

walltime-js's People

Contributors

jgable avatar geedew avatar dansnetwork avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.