test メソッド

[アーティクル]
08/09/2011

文字列内に正規表現パターンに一致する部分が存在するかどうかを示すブール値を返します。

function test(str : String) : Boolean

引数

str
必ず指定します。検索対象となる文字列を指定します。

解説

test メソッドは、文字列内にパターンに一致する部分が存在するかどうかを調べ、存在する場合は真 (true) を返し、存在しない場合は偽 (false) を返します。一致する文字列が見つかった場合は、グローバルな RegExp オブジェクトのプロパティが検索結果を反映して更新されます。

正規表現でグローバルフラグが設定されている場合は、test により、lastIndex の値で指定された位置から文字列の検索が開始されます。グローバルフラグが設定されていない場合、test により、lastIndex の値に関係なく、検索は文字列の先頭から開始されます。

使用例

test メソッドの使用例を次に示します。この例を使用するには、正規表現パターンおよび文字列に関数を渡します。関数は、文字列内に正規表現パターンに一致する部分が存在するかどうかを調べ、検索結果を示す文字列を返します。

function TestDemo(re, teststring)
{
    // Test string for existence of regular expression.
    var found = re.test(teststring)

    // Format the output.
    var s = "";
    s += "'" + teststring + "'"

    if (found)
        s += " contains ";
    else
        s += " does not contain ";  
      
    s += "'" + re.source + "'"
    return(s);
}