Symbol.search
The Symbol.search
well-known symbol specifies the method that returns the index within a string that matches the regular expression. This function is called by the String.prototype.search()
method.
For more information, see RegExp.prototype[@@search]()
and String.prototype.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')));
// expected output: 3
Specifications
Specification |
---|
ECMAScript Language Specification # sec-symbol.search |
Browser compatibility
BCD tables only load in the browser