String.prototype.startsWith()
The startsWith() method of String values determines whether this string begins with the characters of a specified string, returning true or false as appropriate.
The startsWith() method of String values determines whether this string begins with the characters of a specified string, returning true or false as appropriate.
JavaScript Demo: String.prototype.startsWith()
```js interactive-example const str = "Saturday night plans";
console.log(str.startsWith("Sat")); // Expected output: true
console.log(str.startsWith("Sat", 3)); // Expected output: false
## Syntax
```js-nolint
startsWith(searchString)
startsWith(searchString, position)
Parameters
searchString- : The characters to be searched for at the start of this string. Cannot be a regex. All values that are not regexes are coerced to strings, so omitting it or passing
undefinedcausesstartsWith()to search for the string"undefined", which is rarely what you want. position- : The start position at which
searchStringis expected to be found (the index ofsearchString's first character). Defaults to0.
Return value
true if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.
Exceptions
- TypeError
- : Thrown if
searchStringis a regex.
Description
This method lets you determine whether or not a string begins with another string. This method is case-sensitive.
Examples
Using startsWith()
const str = "To be, or not to be, that is the question.";
console.log(str.startsWith("To be")); // true
console.log(str.startsWith("not to be")); // false
console.log(str.startsWith("not to be", 10)); // true
Specifications
Browser compatibility
See also
- Polyfill of
String.prototype.startsWithincore-js - es-shims polyfill of
String.prototype.startsWith - String.prototype.endsWith()
- String.prototype.includes()
- String.prototype.indexOf()
- String.prototype.lastIndexOf()