콘텐츠로 이동

FormatRelativeKoOptions — @gj-kit/format

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

import { FormatRelativeKoOptions } from '@gj-kit/format';
type FormatRelativeKoOptions = {
/** Required explicit clock — this family never reads the system clock itself. */
readonly now: Date;
/** Required: `true` → `'3분 전'`, `false` → `'3분전'`. The apps disagreed. */
readonly suffixSpace: boolean;
/** Required: rendered for null/invalid input. The apps disagreed (`''` vs `'-'`). */
readonly fallback: string;
/**
* Required policy for timestamps after `now`:
* `'empty'` returns `''`; a function renders an absolute form instead.
*/
readonly onFuture: 'empty' | ((date: Date) => string);
/** Label for the <60s bucket. Default `'방금'`. */
readonly justNowLabel?: string | undefined;
/** When set, the 1-day bucket renders this literal (e.g. `'어제'`) instead of `'1일 전'`. */
readonly yesterdayLabel?: string | undefined;
} & ({
readonly maxDays?: undefined;
readonly onOverflow?: undefined;
} | {
/** Elapsed days >= maxDays switch to onOverflow (e.g. 7 → absolute date). */
readonly maxDays: number;
/** Required together with maxDays — there is no built-in absolute rendering. */
readonly onOverflow: (date: Date) => string;
});

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

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