RegExp: lastIndex

lastIndex は RegExp インスタンスの読み書き可能なプロパティで、次の一致を開始する位置を指定します。

なお、 lastIndex は RegExp プロトタイプのプロパティではありませんが、 RegExp インスタンスからのみ公開されます。

試してみましょう

RegExp: lastIndex のプロパティ属性
書込可能 可
列挙可能 不可
設定可能 不可

解説

このプロパティは、正規表現インスタンスがグローバル検索を示すために g フラグを使用した場合、または粘着的検索を示すために y フラグを使用した場合にのみ設定されます。 test() および exec() が指定された入力に対して呼び出されたとき、以下の規則が適用されます。

  • lastIndex が入力の長さよりも大きい場合、 exec() または test() は一致するものを見つけられず、 lastIndex は 0 に設定されます。
  • lastIndex が入力の長さ以下であった場合、 exec() または test() は lastIndex から一致するものを探そうとします。
    • exec() または test() が一致するものを見つけた場合 lastIndex は入力の中の一致する文字列の末尾の位置に設定されます。
    • exec() または test() が一致するものを見つけられなかった場合、 lastIndex は 0 に設定されます。

例

lastIndex の使用

例えば、以下の一連の処理を考えてみてください。

var re = /(hi)?/g;

空文字列に一致します。

console.log(re.exec('hi'));
console.log(re.lastIndex);

["hi", "hi"] を返し、 lastIndex は 2 になります。

console.log(re.exec('hi'));
console.log(re.lastIndex);

返値は ["", undefined] で、 0 番目の要素が一致文字列となる空の配列です。この場合、 lastIndex が 2 (現在も 2) であり、hi の長さが 2 であるため、空の文字列となります。

仕様書

Specification
ECMAScript Language Specification
# sec-properties-of-regexp-instances

ブラウザーの互換性

BCD tables only load in the browser

関連情報