Skip to content

FormatTimeZone — @gj-kit/format

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

import { FormatTimeZone } from '@gj-kit/format';
/**
* Explicit time zone selector. There is deliberately no default:
* - `'UTC'` — UTC wall clock (no Intl involved).
* - `'device'` — the runtime's local time (no Intl involved). This is an
* explicit opt-in, not a silent fallback: the dependency on
* device state is visible at every call site.
* - IANA zone name — e.g. `'Asia/Seoul'`; resolved via `Intl.DateTimeFormat`.
* An unknown name throws `FormatError('ERR_TIMEZONE_INVALID')`.
* Ask {@link canFormatTimeZone} first if the runtime's Intl
* is not known to be healthy.
*/
type FormatTimeZone = 'UTC' | 'device' | (string & {});

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.

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