Pattern: extract()

与えられた文字列から対象のパターン中のラベルに一致する単語を抽出します。

構文

pattern.extract(s) => { params, first, last } | null

引数

• s: string

  単語を抽出する文字列です。

返値: { params, first, last } | null

s がパターンに一致していた場合、以下のプロパティを持つオブジェクトを返します：

• params: object

  各ラベル名とラベルに一致した単語を組とするオブジェクトです。

• first: Array<string>

  後方一致または部分一致の場合、対象のパターンの前方のワイルドカードに一致する部分単語列です。前方一致または完全一致の場合は空配列となります。

• last: Array<string>

  前方一致または部分一致の場合、対象のパターンの後方のワイルドカードに一致する部分単語列です。後方一致または完全一致の場合は空配列となります。

s がパターンに一致していなかった場合は null を返します。

例外

• TypeError
  • 引数 s が文字列でなかった場合。