Registry / productivity / aussie-date-formatter

aussie-date-formatter

library0.0.3jsnpmunverified

A JavaScript/TypeScript date formatter that outputs dates and times in the Australian format (dd/mm/yyyy, 12-hour clock with AM/PM, timezone abbreviations like AEDT). Current version 0.0.3. It works with Node's default locale (en-US) and supports any timezone via the Intl API, though US timezones may not display correctly due to offset limitations. The library provides Canadian-friendly formatting for date strings and ISO variants. It is lightweight and has no external dependencies.

productivity

npm install aussie-date-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AUSSIE-DATE-FORMAT

aussie-date-formatter

productivityjavascriptv0.0.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DateFormatter

✓ import { DateFormatter } from 'aussie-date-formatter'

✗ import DateFormatter from 'aussie-date-formatter'

Default export is an object containing DateFormatter; named import is required.

DateFormatter

✓ const df = require('aussie-date-formatter'); const formatter = new df.DateFormatter(...)

✗ require('aussie-date-formatter').default

CommonJS: require returns an object with DateFormatter as a property, not a default export.

DateFormatter

✓ import type { DateFormatter } from 'aussie-date-formatter'

TypeScript type import for type-only usage.

Create a DateFormatter with a date and timezone, then format using various methods.

import { DateFormatter } from 'aussie-date-formatter'; const date = new Date('2021-08-03T14:15:16Z'); const formatter = new DateFormatter(date, 'Australia/Sydney'); console.log(formatter.toDate()); // 4/2/2021 console.log(formatter.toTime()); // 1:15:16 AM console.log(formatter.toDateTimeTz()); // 4/2/2021 1:15:16 AM AEDT console.log(formatter.toIsoDate()); // 2021-04-02 console.log(formatter.toIsoDateTime()); // 2021-02-04T01:15:16+11:00 console.log(formatter.toTime('24')); // 01:15:16

Debug

Known issues

gotchaUS time zones (e.g., America/New_York) may not work correctly because the library relies on the time zone offset information, which is unavailable for US zones.

fix

Use Australian or other non-US time zones; otherwise, consider an alternative library.

affects: >=0.0.0

gotchaThe library only provides formatting methods; it does not parse dates or perform date arithmetic.

fix

Use native Date or a library like date-fns for date manipulation.

affects: >=0.0.0

gotchaThe default format for toDate() is dd/mm/yyyy, which may be confused with mm/dd/yyyy by users from other locales.

fix

Always verify the output format; use toIsoDate() for unambiguous ISO format.

affects: >=0.0.0

gotchaThe toTime('2-digit') option uses Intl.DateTimeFormat with hour12: true by default; it always returns 12-hour format with leading zero.

fix

Use toTime('24') for 24-hour format.

affects: >=0.0.0

Errors

Common errors & fixes

TypeError: DateFormatter is not a constructor

Using require('aussie-date-formatter').DateFormatter incorrectly, or importing as default.

fix

Use const { DateFormatter } = require('aussie-date-formatter');

Cannot convert undefined or null to object

Passing an undefined or null date to the DateFormatter constructor.

fix

Ensure date argument is a valid Date object.

RangeError: Invalid time zone specified: "America/New_York"

The library may not support all time zones; US zones are known to be problematic.

fix

Use a supported time zone like 'Australia/Sydney' or 'Europe/London'.

Upgrade

Version history

0.0.3latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

31 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/matthewfleming/aussie-date-formatter ↗

packageaussie-date-formatter ↗

homepagehttps://github.com/matthewfleming/aussie-date-formatter#readme ↗