FormatDateOptions — @gj-kit/format

A public interface from @gj-kit/format. The signature below is taken directly from the 0.1.1 release declaration.

Verified import example

import { FormatDateOptions } from '@gj-kit/format';

Signature, parameters, and return type

interface FormatDateOptions<TFallback = string> {
    /** Required. See {@link FormatTimeZone} — omission is a compile error. */
    readonly timeZone: FormatTimeZone;
    /**
     * Required separator between year/month/day segments.
     * The source apps disagreed (`2026-06-08` vs `2026.06.08`), so neither
     * spelling is a silent default.
     */
    readonly separator: '-' | '.';
    /**
     * Rendered for null/undefined/invalid input and for instants outside the
     * supported window `0001-01-01T14:00:00Z … 9999-12-31T09:59:59.999Z`.
     *
     * That window — not "years 1–9999" — is the actual guard: it is the set of
     * instants every zone this package accepts (-12:00…+14:00) renders as a year
     * between 1 and 9999, so the IANA path and the `'UTC'`/`'device'` paths agree
     * byte for byte on where the range ends. `2026-06-08` in any zone is far
     * inside it; only the two end years are narrowed by a day.
     *
     * Default `'-'`.
     */
    readonly fallback?: TFallback | undefined;
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/format
• Version: 0.1.1
• Public entry: .
• Source: GitHub