Name

RegExp.test() — test whether a string matches a pattern

Synopsis

regexp.test(string)

Arguments

string

The string to be tested.

Returns

true if string contains text that matches regexp; false otherwise.

Throws

TypeError

If this method is invoked on an object that is not a RegExp.

Description

test() tests string to see if it contains text that matches regexp. If so, it returns true; otherwise, it returns false. Calling the test() method of a RegExp r and passing it the string s is equivalent to the following expression:

(r.exec(s) != null)

Example

var pattern = /java/i;
pattern.test("JavaScript");   // Returns true
pattern.test("ECMAScript");   // Returns false

Get JavaScript: The Definitive Guide, 6th Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.