콘텐츠로 이동

FormatDateOptions — @gj-kit/format

@gj-kit/format에서 공개하는 interface입니다. package version 0.1.1의 release declaration을 그대로 표시합니다.

import { FormatDateOptions } from '@gj-kit/format';
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;
}

이 선언은 매개변수, optionality, 제네릭, 반환값, 공개 union/type 계약의 정본입니다. 호출 전 필요한 환경·권한·오류 경계는 패키지 Golden path와 이 subpath의 import 조건을 함께 확인하세요.

  • 패키지: @gj-kit/format
  • 버전: 0.1.1
  • 공개 entry: .
  • 소스: GitHub