Pattern: map()

パターン中のラベルを与えられた配列の成分またはオブジェクトのプロパティで置き換えます。

構文

pattern.map(params) => string

引数

• params: any[] | { [param_name: string]: any }

  ラベルを置き換える値の配列、またはラベルと同名のプロパティを持つオブジェクトです。

  文字列でない配列成分やプロパティは文字列に変換されます。

  warning

  当該のオブジェクトの実装する toString() 関数が意図したものになっていないなら、事前に文字列変換を行う必要があります。

返値: string

ラベルを与えられた単語で置き換えた結果の文字列です。

例外

• TypeError
  • 引数 params が非 null のオブジェクトでなかった場合。
  • 与えられた配列の長さがラベルの個数より少なかった場合。
  • 与えられたオブジェクトが、いずれかのラベルに対応するプロパティを持っていなかった場合。

解説

配列を与えた場合、ラベルの出現順にしたがって配列成分の値に置換されます。

配列でないオブジェクトを与えた場合、各ラベルは与えられたオブジェクトの同名のプロパティの値へ置換されます。