This documentation is archived and is not being maintained.

test Method

Returns a Boolean value that indicates whether a regular expression pattern exists in a searched string.

function test(str : String) : Boolean

Arguments

str
Required. The string on which to perform the search.

Remarks

The test method checks to see if a pattern exists within a string and returns true if so, and false otherwise. If a match is found, the properties of the global RegExp object are updated to reflect the results of the match.

If the global flag is set for a regular expression, test searches the string beginning at the position indicated by the value of lastIndex. If the global flag is not set, test ignores the value of lastIndex and searches from the beginning of the string.

Example

The following example illustrates the use of the test method. To use this example, pass the function a regular expression pattern and a string. The function will test for the occurrence of the regular expression pattern in the string and return a string indicating the results of that search:

function TestDemo(re, s){
   var s1;                         //Declare variable.
   // Test string for existence of regular expression.
   if (re.test(s))                 //Test for existence.
      s1 = " contains ";           //s contains pattern.
   else
      s1 = " does not contain ";   //s does not contain pattern.
   return("'" + s + "'" + s1 + "'"+ re.source + "'"); //Return string.
}

Requirements

Version 3

See Also

RegExp Object | Regular Expression Syntax

Applies To: Regular Expression Object

Show: