Console

Settings

Sign out

Notifications

Alexa

Amazonアプリストア

AWS

ドキュメント

Support

My Cases

Console

Vega開発者向けドキュメント

ホーム

開発

設計と開発

公開

リファレンス

サポート

MessageFormatClassic

MessageFormatClassic APIでは、メッセージのフォーマットに従来のICU MessageFormat（英語のみ）パターンが採用されています。

MessageFormatClassic APIでは、パターン内の形式として、名前付き引数と番号の引数の両方がサポートされます。名前付き引数スタイルを使用すると、わかりやすい名前の引数を指定でき、開発者や翻訳者が読みやすくなります。さらに、パターン内の引数にどのような値が入るかをより正確に推測できます。

例

import { MessageFormatClassic } from '@amazon-devices/keplerscript-kepleri18n-lib';
...
    // パターンは文字列リソースから取得してください。ここでは例を簡単にするためにハードコードしています。
    const pattern: string = "カーナンバー{carNumber}の勝ち！ おめでとう、{driverName}！";
    const carNumber: number = 3;
    const driverName: string = "アリス";
    const argMap = new Map<string, number | string | Date>();
    argMap.set("carNumber", carNumber);
    argMap.set("driverName", driverName);
    const message: string | null = MessageFormatClassic.format(pattern, argMap);
    if (message === null) {
        // エラー
        return;
    }
    // メッセージは「カーナンバー3の勝ち！ おめでとう、アリス！」

import { MessageFormatClassic } from '@amazon-devices/keplerscript-kepleri18n-lib';
...
    // パターンは文字列リソースから取得してください。ここでは例を簡単にするためにハードコードしています。
    const pattern: string = "カーナンバー{0}の勝ち！ おめでとう、{1}！";
    const carNumber: number = 11;
    const driverName: string = "ボブ";
    const message: string | null = MessageFormatClassic.formatPositional(pattern, carNumber, driverName);
    if (message === null) {
        // エラー
        return;
    }
    // メッセージは「カーナンバー11の勝ち！ おめでとう、ボブ！」

コンストラクタ

new MessageFormatClassic()

new MessageFormatClassic(): MessageFormatClassic

戻り値

MessageFormatClassic

メソッド

format()

static format(pattern, args): null | string

指定されたパターンをデフォルトロケールの名前付き引数でフォーマットします。

パラメーター

pattern

string

従来のメッセージフォーマットパターンです。

args

Map<string, string | number | Date>

引数名からその値へのマップです。

戻り値

null | string

成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。

formatPositional()

static formatPositional(pattern, …args): null | string

指定されたパターンをデフォルトロケールの番号付き引数でフォーマットします。

パラメーター

pattern

string

従来のメッセージフォーマットパターンです。

args

…(string | number | Date)[]

引数値の配列です。

戻り値

null | string

成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。

formatPositionalWithLocale()

static formatPositionalWithLocale(pattern, locale, …args): null | string

指定されたパターンを、指定されたロケールの番号付き引数でフォーマットします。

パラメーター

pattern

string

従来のメッセージフォーマットパターンです。

locale

BCP-47のロケール文字列です。このパラメーターがnullまたは空の文字列の場合、デフォルトロケールが使用されます。

null string

args

…(string | number | Date)[]

引数値の配列です。

戻り値

null | string

成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。

formatWithLocale()

static formatWithLocale(pattern, locale, args): null | string

指定されたパターンを、指定されたロケールの名前付き引数でフォーマットします。

パラメーター

pattern

string

従来のメッセージフォーマットパターンです。

locale

BCP-47のロケール文字列です。このパラメーターがnullまたは空の文字列の場合、デフォルトロケールが使用されます。

null string

args

Map<string, string | number | Date>

引数名からその値へのマップです。

戻り値

null | string

成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。

getMajorVersion()

static getMajorVersion(): number

メジャーバージョン番号を取得します。

戻り値

number

メジャーバージョン番号。

getMinorVersion()

static getMinorVersion(): number

マイナーバージョン番号を取得します。

戻り値

number

マイナーバージョン番号。

getPatchVersion()

static getPatchVersion(): number

パッチバージョン番号を取得します。

戻り値

number

パッチバージョン番号。

Last updated: 2025年9月29日