Firefox Tomorrow

javascript instance method

String.prototype.search()

View on MDN ↗

The search() method of String values executes a search for a match between a regular expression and this string, returning the index of the first match in the string.

Interactive exampleOpen the canonical MDN source to run this embedded demo.
const paragraph = "I think Ruth's dog is cuter than your dog!";

// Anything not a word character, whitespace or apostrophe
const regex = /[^\w\s']/g;

console.log(paragraph.search(regex));
// Expected output: 41

console.log(paragraph[paragraph.search(regex)]);
// Expected output: "!"

Syntax

search(regexp)

Parameters

  • regexp

    • : A regular expression object, or any object that has a Symbol.search method.

      If regexp is not a RegExp object and does not have a Symbol.search method, it is implicitly converted to a RegExp by using new RegExp(regexp).

Return value

The index of the first match between the regular expression and the given string, or -1 if no match was found.

Description

The implementation of String.prototype.search() doesn’t do much other than calling the Symbol.search method of the argument with the string as the first parameter. The actual implementation comes from RegExp.prototype[Symbol.search]().

The g flag of regexp has no effect on the search() result, and the search always happens as if the regex’s lastIndex is 0. For more information on the behavior of search(), see RegExp.prototype[Symbol.search]().

When you want to know whether a pattern is found, and also know its index within a string, use search().

  • If you only want to know if it exists, use the test() method, which returns a boolean.
  • If you need the content of the matched text, use match() or exec().

Examples

The following example searches a string with two different regex objects to show a successful search (positive value) vs. an unsuccessful search (-1).

const str = "hey JudE";
const re = /[A-Z]/;
const reDot = /[.]/;
console.log(str.search(re)); // returns 4, which is the index of the first capital letter "J"
console.log(str.search(reDot)); // returns -1 cannot find '.' dot punctuation

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also