MessageFormatClassic APIでは、メッセージのフォーマットに従来のICU MessageFormat(英語のみ)パターンが採用されています。
MessageFormatClassic APIでは、パターン内の形式として、名前付き引数と番号の引数の両方がサポートされます。名前付き引数スタイルを使用すると、わかりやすい名前の引数を指定でき、開発者や翻訳者が読みやすくなります。さらに、パターン内の引数にどのような値が入るかをより正確に推測できます。
コンストラクタ
new MessageFormatClassic()
new MessageFormatClassic(): MessageFormatClassic戻り値
MessageFormatClassicメソッド
format()
static format(pattern: string, args: Map<string, string | number | Date>): string | null
指定されたパターンをデフォルトロケールの名前付き引数でフォーマットします。
パラメーター
pattern
string
従来のメッセージフォーマットパターンです。
args
Map<string, string | number | Date>
引数名からその値へのマップです。成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。
戻り値
string | null
formatPositional()
static formatPositional(pattern: string, args?: (string | number | Date)[]): string | null
指定されたパターンをデフォルトロケールの番号付き引数でフォーマットします。
パラメーター
pattern
string
従来のメッセージフォーマットパターンです。
args?
(string | number | Date)[]
引数値の配列。成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。
戻り値
string | null
formatPositionalWithLocale()
static formatPositionalWithLocale(pattern: string, locale: string | null, args?: (string | number | Date)[]): string | null
番号付き引数を使い、かつ、指定されたロケールで、指定されたパターンをフォーマットします。
パラメーター
pattern
string
従来のメッセージフォーマットパターンです。
locale
string | null
BCP-47のロケール文字列です。このパラメーターがnullまたは空の文字列の場合、デフォルトロケールが使用されます。
args?
(string | number | Date)[]
引数値の配列。成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。
戻り値
string | null
formatWithLocale()
static formatWithLocale(pattern: string, locale: string | null, args: Map<string, string | number | Date>): string | null
名前付き引数を使い、かつ、指定されたロケールで、指定されたパターンをフォーマットします。
パラメーター
pattern
string
従来のメッセージフォーマットパターンです。
locale
string | null
BCP-47のロケール文字列です。このパラメーターがnullまたは空の文字列の場合、デフォルトロケールが使用されます。
args
Map<string, string | number | Date>
引数名からその値へのマップです。成功した場合はフォーマットされたメッセージ、失敗した場合はnullになります。
戻り値
string | null
getMajorVersion()
static getMajorVersion(): number
メジャーバージョン番号を取得します。メジャーバージョン番号。
戻り値
number
getMinorVersion()
static getMinorVersion(): number
マイナーバージョン番号を取得します。マイナーバージョン番号。
戻り値
number
getPatchVersion()
static getPatchVersion(): number
パッチバージョン番号を取得します。パッチバージョン番号。
戻り値
number

