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.
Value
The well-known symbol @@search
.
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