Moment Timezone API

api.md

Formats

// Packed
"America/Los_Angeles|PST PDT|70 60|010101010101|-h234i0 fgd0 wef0 fgd0 wef0 fgd0 wef0"

// Unpacked
{
	name    : "America/Los_Angeles",
	abbrs   : ["PST", "PDT", "PST", "PDT", "PST", "PDT", "PST", "PDT", "PST", "PDT"],
	offsets : [420, 480, 420, 480, 420, 480, 420, 480, 420, 480, 420, 480, 420, 480],
	untils  : [-134089073429, -134074893883, -13407683724, -134074372626, -134074937463, -134074937463]
}

Data utils

// in moment-timezone.js
moment.tz.unpack(packed string) > unpacked object
moment.tz.unpackBase60(string) > number

// in moment-timezone-utils.js
moment.tz.pack(unpacked object) > packed string
moment.tz.packBase60(number, precision) > string
moment.tz.filterYear(unpacked object, min, max) > new unpacked object

External API

moment.tz.add(packed string[])
moment.tz.add(packed string)
moment.tz.link(nameA, nameB)
moment.tz.link("nameA|nameB")
moment.tz.link("nameA|nameB"[])
moment.tz.zones() > Zone[]

Zone API

moment.tz.Zone(packed string)
moment.tz.Zone.prototype.offsetFor(moment)
moment.tz.Zone.prototype.abbrFor(moment)
moment.tz.Zone.prototype._indexFor(moment)

Interaction with moment

moment.tz(..., zone name)
moment.fn.tz(zone name)

Folder structure

/build
    moment-timezone.min.js
    moment-timezone-utils.min.js
    moment-timezone-with-data.js
    moment-timezone-with-data.min.js
/data
    /source > git submodule
    /packed
        latest.json
        2014a.json
        2014b.json
    /unpacked
        latest.json
        2014a.json
        2014b.json
    /zdump
        latest.json
        2014a.json
        2014b.json
/tasks
    /helpers
        zic.js
        zdump.js
        dedupe.js
    build-data.js
    build-tests.js
    build-zdump.js
/tests
    /zones
        /africa
        /america
        /...
    /moment-timezone
        add.js
        link.js
        moment-tz.js
        moment-fn-tz.js
        unpack.js
        unpack-base-62.js
        zone.js
        zone-abbr-for.js
        zone-offset-for.js
        zones.js
    /moment-timezone-utils
        pack.js
        pack-base-62.js
    helpers.js
moment-timezone.js
moment-timezone-utils.js

TODO

• Move zone tests to /tests/zones
• Move moment-timezone.json to /data/packed/latest.json
• Write moment.tz.unpackBase60 + tests
• Write moment.tz.unpack + tests
• Write moment.tz.packBase60 + tests
• Write moment.tz.pack + tests
• Write moment.tz.Zone + tests
• Write moment.tz.Zone#_indexFor + tests
• Write moment.tz.Zone#offsetFor + tests
• Write moment.tz.Zone#abbrFor + tests
• Write moment.tz.add + tests
• Write moment.tz.link + tests
• Write moment.tz.zones + tests
• Write moment.tz.filterYear + tests
• Write zic task helper (data/source/northamerica > .temp/zic/america/los_angeles)
• Write zdump task helper (.temp/zic/america/los_angeles > data/zdump/*.json)
• Write dedupe task helper (data/zdump/.json > data/unpacked/.json)
• Write pack task helper (data/unpacked/.json > data/packed/.json)
• Write zone test helpers (data/zdump/*.json > tests/zones/america/los_angeles.js)