W3cubDocs

Symbol.search

The Symbol.search static data property represents the well-known symbol @@search. The String.prototype.search() method looks up this symbol on its first argument for the method that returns the index within a string that matches the current object.

For more information, see RegExp.prototype[@@search]() and String.prototype.search().

Try it

Value

The well-known symbol @@search.

Property attributes of `Symbol.search`
Writable	no
Enumerable	no
Configurable	no

Examples

Custom string search

class caseInsensitiveSearch {
  constructor(value) {
    this.value = value.toLowerCase();
  }
  [Symbol.search](string) {
    return string.toLowerCase().indexOf(this.value);
  }
}

console.log("foobar".search(new caseInsensitiveSearch("BaR"))); // 3

Specifications

Specification
ECMAScript Language Specification # sec-symbol.search

Browser compatibility

	Desktop						Mobile						Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	Deno	Node.js
`search`	50	79	49	37	10	50	49	37	10	5.0	50	1.0	6.0.0