test Method

Description

Returns a Boolean value that indicates whether or not a pattern exists in a searched string.

Syntax

rgexp.test(str)

The test method syntax has these parts:

Part	Description
rgexp	Required. A Regular Expression object. Can be a variable name or a literal.
str	Required. The string to test a search on.

Remarks

The test method checks to see if a pattern exists within a string and returns true if so, and false otherwise.

The RegExp object is not modified by the test method.

The following example illustrates the use of the test method:

function TestDemo(re, s)
{
  var s1;
  // Test string for existence of regular expression.
  if (re.test(s))
    s1 = " contains ";
  else
    s1 = " does not contain ";
  // Get text of the regular expression itself.
  return(s + s1 + re.source);
}