Skip to content

vue-i18n / general / ComposerDateTimeFormatting

インターフェース: ComposerDateTimeFormatting()<DateTimeFormats, Locales, DefinedDateTimeFormat, C, M, ResourceKeys>

日時フォーマット関数

備考

これは Composer のインターフェースです。

Vue I18n Composition

型パラメータ

型パラメータデフォルト型
DateTimeFormats extends Record<string, any>object
Locales"en-US"
DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat>RemovedIndexResources<DefineDateTimeFormat>
CIsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K] }> : never
MIsEmptyObject<DateTimeFormats> extends false ? PickupFormatKeys<DateTimeFormats> : never
ResourceKeys extends C | MIsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never

呼び出しシグネチャ

ts
ComposerDateTimeFormatting(value): string;

日時フォーマット

パラメータ

パラメータ説明
valuestring | number | Date値、タイムスタンプ数値または Date インスタンスまたは ISO 8601 文字列

戻り値

string

フォーマットされた値

備考

この関数がリアクティブコンテキストで使用される場合、ロケールが変更されると一度再評価されます。

useI18n で UseI18nScope 'local' またはいくつかの UseI18nOptions が指定されている場合、グローバルスコープの日時フォーマットよりも、ローカルスコープの日時フォーマットが優先的に使用されます。

そうでない場合、グローバルスコープの日時フォーマットでフォーマットされます。

参照:

呼び出しシグネチャ

ts
ComposerDateTimeFormatting<Value, Key, OptionsType>(value, keyOrOptions): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;

日時フォーマット

型パラメータ

型パラメータデフォルト型
Value extends string | number | Datenumber
Key extends stringstring
OptionsType| ResourceKeys | Key | DateTimeOptions<ResourceKeys | Key, Locales>

パラメータ

パラメータ説明
valueValue値、タイムスタンプ数値または Date インスタンスまたは ISO 8601 文字列
keyOrOptionsOptionsType日時フォーマットのキー、または日時フォーマットの追加オプション

戻り値

IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string

フォーマットされた値

備考

オーバーロードされた d

このオーバーロードされた d では、日時フォーマットに登録されたキーの日時フォーマットでフォーマットします。

呼び出しシグネチャ

ts
ComposerDateTimeFormatting<Value, Key, OptionsType>(
    value,
    keyOrOptions,
    locale): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;

日時フォーマット

型パラメータ

型パラメータデフォルト型
Value extends string | number | Datenumber
Key extends stringstring
OptionsType| ResourceKeys | Key | DateTimeOptions<ResourceKeys | Key, Locales>

パラメータ

パラメータ説明
valueValue値、タイムスタンプ数値または Date インスタンスまたは ISO 8601 文字列
keyOrOptionsOptionsType日時フォーマットのキー、または日時フォーマットの追加オプション
localeLocalesロケール。グローバルスコープまたはローカルスコープより優先して使用されます。

戻り値

IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string

フォーマットされた値

備考

オーバーロードされた d

このオーバーロードされた d では、対象ロケールで日時フォーマットに登録されたキーの日時フォーマットでフォーマットします