JavaScript String includes() Method
In JavaScript, the includes() method determines whether a string contains the given characters within it or not. This method returns true if the string contains the characters, otherwise, it returns false.
Note: The includes() method is case sensitive i.e, it will treat the Uppercase characters and Lowercase characters differently.
Syntax:
string.includes(searchvalue, start)
Parameters:
- search value: It is the string in which the search will take place.
- start: This is the position from where the search will be processed
(although this parameter is not necessary if this is not mentioned the search will begin from the start of the string).
Return Value: Returns either a Boolean true indicating the presence or it returns a false indicating the absence.
Below are examples of the String includes() Method.
Example 1: This method shows the basic use of the String includes() Method.
javascript
<script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "Geeks" ); console.log(check) </script> |
Output:
true
Example 2: Since the second parameter is not defined, the search will take place from the starting index. And it will search for Geeks, as it is present in the string, and it will return a true.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "Geeks" ); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
true
Example 3: Even in this case the second parameter is not defined, so the search will take place from the starting index. But as this method is case sensitive it will treat the two strings differently, hence returning a boolean false.
Since it is case sensitive.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "geeks" ); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
false
Example 4: This example checks for a string at a fixed position in the str variable.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "o" , 17); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
true
Example 5: This example checks for a string in the str variable and returns false as it is not found at the specified position.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "o" , 18); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
false
Exceptions: The search will not be processed if the second parameter i.e computed index(starting index) is greater than or equal to the string length and hence return false.
Example 1: This example describes the above-explained approach.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "o" , 25); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
false
Example 2: If the computed index(starting index) i.e the position from which the search will begin is less than 0, the entire array will be searched.
javascript
<p id= "GFG" ></p> <script> var str = "Welcome to GeeksforGeeks." ; var check = str.includes( "o" , -2); document.getElementById( "GFG" ).innerHTML = check; </script> |
Output:
true
We have a complete list of Javascript string methods, to check those please go through this Javascript String Complete reference article.
Supported Browser:
- Chrome 41 and above
- Edge 12 and above
- Firefox 40 and above
- Opera 28 and above
- Safari 9 and above
JavaScript is best known for web page development but it is also used in a variety of non-browser environments. You can learn JavaScript from the ground up by following this JavaScript Tutorial and JavaScript Examples.
Please Login to comment...