Symbol.search

The Symbol.search static data property represents the well-known symbol Symbol.search. The {{jsxref("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[Symbol.search]() and {{jsxref("String.prototype.search()")}}.

{{InteractiveExample("JavaScript Demo: Symbol.search")}}

```js interactive-example class Search1 { constructor(value) { this.value = value; } Symbol.search { return string.indexOf(this.value); } }

console.log("foobar".search(new Search1("bar"))); // Expected output: 3

## Value

The well-known symbol `Symbol.search`.

{{js_property_attributes(0, 0, 0)}}

## Examples

### Custom string search

```js
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#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

• Polyfill of Symbol.search in core-js
• {{jsxref("Symbol.match")}}
• {{jsxref("Symbol.matchAll")}}
• {{jsxref("Symbol.replace")}}
• {{jsxref("Symbol.split")}}
• {{jsxref("String.prototype.search()")}}
• RegExp.prototype[Symbol.search]()