String.prototype.startsWith()

The startsWith() method determines whether a string begins with the characters of a specified string, returning true or false as appropriate.

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

Syntax

str.startsWith(searchString[, position])

Parameters

searchString

The characters to be searched for at the start of this string.

position Optional

The position in this string at which to begin searching for searchString; defaults to 0.

Return value

true if the given characters are found at the beginning of the string; otherwise, false.

Description

This method lets you determine whether or not a string begins with another string. This method is case-sensitive.

Examples

Using startsWith()

//startswith
var 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

Polyfill

This method has been added to the ECMAScript 2015 specification and may not be available in all JavaScript implementations yet. However, you can polyfill String.prototype.startsWith() with the following snippet:

if (!String.prototype.startsWith) {
    Object.defineProperty(String.prototype, 'startsWith', {
        value: function(search, pos) {
            pos = !pos || pos < 0 ? 0 : +pos;
            return this.substring(pos, pos + search.length) === search;
        }
    });
}

A more robust (fully ES2015 specification compliant), but less performant and compact, Polyfill is available on GitHub by Mathias Bynens.

Specifications

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

See also

• String.prototype.endsWith()
• String.prototype.includes()
• String.prototype.indexOf()
• String.prototype.lastIndexOf()