Skip to content

vue-i18n / general / ComposerNumberFormatting

インターフェース: ComposerNumberFormatting()<NumberFormats, Locales, DefinedNumberFormat, C, M, ResourceKeys>

数値フォーマット関数

備考

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

Vue I18n コンポジション

型パラメータ

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

呼び出しシグネチャ

ts
ComposerNumberFormatting(value): string;

数値フォーマット

パラメータ

パラメータ説明
valuenumber数値

戻り値

string

フォーマットされた値

備考

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

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

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

詳細は以下を参照してください:

呼び出しシグネチャ

ts
ComposerNumberFormatting<Key, OptionsType>(value, keyOrOptions): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;

数値フォーマット

型パラメータ

型パラメータデフォルト型
Key extends stringstring
OptionsType| ResourceKeys | Key | NumberOptions<ResourceKeys | Key, Locales>

パラメータ

パラメータ説明
valuenumber数値
keyOrOptionsOptionsType数値フォーマットのキー、または数値フォーマットの追加オプション

戻り値

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

フォーマットされた値

備考

オーバーロードされた n

このオーバーロードされた n では、登録された数値フォーマットのキーに対して数値フォーマットを行います。

呼び出しシグネチャ

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

数値フォーマット

型パラメータ

型パラメータデフォルト型
Key extends stringstring
OptionsType| ResourceKeys | Key | NumberOptions<ResourceKeys | Key, Locales>

パラメータ

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

戻り値

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

フォーマットされた値

備考

オーバーロードされた n

このオーバーロードされた n では、対象ロケールの数値フォーマットで登録されたキーに対して数値フォーマットを行います。