JavaScript Symbol search property determines the method that returns the index within a string that matches the regular expression. This function is called by the String search() method.
Syntax:
[Symbol.search](string)
Parameters: It accepts single parameter “String”.
Return value: This returns the position of a string where it matches and if not matches it will return -1.
Below examples illustrate the Symbol search property in JavaScript:
Example 1:
<script> // JavaScript example to illustrate // Symbol.search property class obj { constructor(value) { this .value = value; } [Symbol.search](string) { return string.indexOf( this .value); } } console.log( 'Geeksforneveropen' .search( new obj( 'Geek' ))); console.log( 'Geeksforneveropen' .search( new obj( 'geek' ))); </script> |
Output:
0 8
Example 2:
<script> // JavaScript program to illustrate // the Symbol.search property class S { constructor(value) { this .value = value; } [Symbol.search](string) { return string.indexOf( this .value); } } console.log( 'GEEKSFORGEEKS' .search( new S( 'geek' ))); console.log( 'GEEKSFORGEEKS' .search( new S( 'Geek' ))); </script> |
Output:
-1 -1
Supported Browsers: The browsers supported by Symbol search property are listed below:
- Google Chrome 50 and above
- Firefox 49 and above
- Edge 79 and above
- Opera 37 and above
- Apple Safari 10 and above
We have a complete list of Javascript symbols’ properties and methods, to check those please go through the Javascript Symbol Complete Reference article.