Skip to content

vue-i18n / general / ComposerTranslation

インターフェース: ComposerTranslation()<Messages, Locales, DefinedLocaleMessage, C, M, ResourceKeys>

ロケールメッセージ翻訳関数

備考

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

Vue I18n Composition

型パラメータ

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

呼び出しシグネチャ

ts
ComposerTranslation<Key>(key): string;

ロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー

戻り値

string

翻訳されたメッセージ

備考

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

I18nScope 'local' または useI18n で指定された UseI18nOptions がある場合、グローバルスコープのロケールメッセージよりも、ローカルスコープのロケールメッセージが優先的に使用されます。

そうでない場合は、グローバルスコープのロケールメッセージで翻訳されます。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(key, plural): string;

複数形のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
pluralnumber取得する複数形文字列。1 は最初のものを返します。

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、複数形化された翻訳メッセージを返します。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
    key,
    plural,
    options): string;

複数形のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
pluralnumber取得する複数形文字列。1 は最初のものを返します。
optionsTranslateOptions<Locales>翻訳の追加 options

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、複数形化された翻訳メッセージを返します。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

オプションの詳細については、TranslateOptions を参照してください。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(key, defaultMsg): string;

既定メッセージがない場合のロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
defaultMsgstring翻訳が見つからなかった場合に返す既定メッセージ

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、翻訳が見つからない場合、既定メッセージを返します。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
    key,
    defaultMsg,
    options): string;

既定メッセージがない場合のロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
defaultMsgstring翻訳が見つからなかった場合に返す既定メッセージ
optionsTranslateOptions<Locales>翻訳の追加 options

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、翻訳が見つからない場合、既定メッセージを返します。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

オプションの詳細については、TranslateOptions を参照してください。

呼び出しシグネチャ

ts
ComposerTranslation<Key>(key, list): string;

リスト補完のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
listunknown[]リスト補完の値

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、ロケールメッセージにはリスト内の各プレースホルダーに対して {0}, {1}, … が含まれている必要があります。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
    key,
    list,
    plural): string;

リスト補完と複数形のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
listunknown[]リスト補完の値
pluralnumber取得する複数形文字列。1 は最初のものを返します。

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、ロケールメッセージにはリスト内の各プレースホルダーに対して {0}, {1}, … が含まれており、複数形化された翻訳メッセージを返します。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
    key,
    list,
    defaultMsg): string;

リスト補完と既定メッセージがない場合のロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
listunknown[]リスト補完の値
defaultMsgstring翻訳が見つからなかった場合に返す既定メッセージ

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

詳細:

このオーバーロードされた t では、ロケールメッセージにはリスト内の各プレースホルダーに対して {0}, {1}, … が含まれており、翻訳が見つからない場合は既定メッセージを返します。

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
    key,
    list,
    options): string;

リスト補完のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
listunknown[]リスト補完の値
optionsTranslateOptions<Locales>翻訳の追加 options

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、ロケールメッセージにはリスト内の各プレースホルダーに対して {0}, {1}, … が含まれています。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

オプションの詳細については、TranslateOptions を参照してください。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(key, named): string;

名前付き補完のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
namedNamedValue名前付き補完の値
optionsTranslateOptions<Locales>翻訳の追加 options

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、各プレースホルダー x に対してロケールメッセージには {x} トークンが含まれています。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

オプションの詳細については、TranslateOptions を参照してください。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
   key,
   named,
   plural): string;

名前付き補完と複数形のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
namedNamedValue名前付き補完の値
pluralnumber取得する複数形文字列。1 は最初のものを返します。

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、各プレースホルダー x に対してロケールメッセージには {x} トークンが含まれており、複数形化された翻訳メッセージを返します。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
   key,
   named,
   defaultMsg): string;

名前付き補完と複数形のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
namedNamedValue名前付き補完の値
defaultMsgstring翻訳が見つからなかった場合に返す既定メッセージ

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、各プレースホルダー x に対してロケールメッセージには {x} トークンが含まれており、翻訳が見つからない場合は既定メッセージを返します。

詳細:

呼び出しシグネチャ

ts
ComposerTranslation<Key>(
   key,
   named,
   options): string;

名前付き補完のためのロケールメッセージ翻訳

型パラメータ

型パラメータ
Key extends string

パラメータ

パラメータ説明
keynumber | ResourceKeys | Key対象のロケールメッセージキー
namedNamedValue名前付き補完の値
optionsTranslateOptions<Locales>翻訳の追加 options

戻り値

string

翻訳されたメッセージ

備考

オーバーロードされた t

このオーバーロードされた t では、各プレースホルダー x に対してロケールメッセージには {x} トークンが含まれています。

また、オプションに従って翻訳がない場合の警告を抑制することもできます。

オプションの詳細については、TranslateOptions を参照してください。

詳細: