Getting Started

Installation

The package can be installed from npmjs.

npm install --save @jetblack/date-tz

DateTz

The main DateTz class provides the functionality of the built in Date class in a modern form, with some of the idiosyncrasies removed (e.g. month 1 is January). Things like year and month are properties. The object itself is immutable; the convenience methods like addMonths return new objects.

Convenience Methods

The library provides the usual convenience methods (e.g. addDays, startOfDay, etc.), but with the addition of a timezone where necessary.

import {
    fetchTimezone,
    startOfToday,
    tzLocal,
    tzUtc,
    DateTz,
    IntlTimezone
} from '@jetblack/date-tz'

// Make a time in the UTC timezone
const unixEpoch = new DateTz(1970, 1, 1, tzUtc)

// Get the start of today relative to the local timezone.
const todayLocal = startOfToday()

// If the timezone isn't specified, it defaults to the local timezone.
// The following passes it explicitly.
const todayLocalExplicit = startOfToday(tzLocal)

// The start of today relative to UTC can be found by passing the UTC timezone.
const todayUTC = startOfToday(tzUtc)

// The start of the day in Tokyo, using Intl.DateTimeFormat time zone information.
const tzChicago = new IntlTimezone('America/Chicago')
const todayChicago = startOfToday(tzChicago)

// The start of the day in Tokyo, using IANA time zone information.
const tzTokyo = await fetchTimezone('Asia/Tokyo')
const todayTokyo = startOfToday(tzTokyo)

What next ?

General Usage