back to Overview

.startsWith()

Checks whether the list or string starts with the other string or list.
Util module only.

Syntax Variants

list.startsWith(otherList)
_.startsWith(list, otherList)
_.startsWith(baseString, otherString)

Parameters

list
A list to check. Can be an array, a Minified list or any other array-like structure with length property.
otherList
A list to find at the beginning of the other string. Can be an array, a Minified list or any other array-like structure with length property. If it is not a list, it will be converted into a single-element list.
baseString
a string to check
otherString
the string to find at the beginning of the other string
(return value)
true if the base list or string starts with the other list/string. False otherwise.

Description

Checks whether the list or string starts with the other string or list.

If you compare lists, each item of the other list is compared with the item at the same position of the base list using _.equals(). Arrays can be used interchangably with lists. If the first argument is a list and the second is not, it will be converted to a list.

If you compare strings, each character of the other string is compared with the character at the same position of the base string.

Example

Checks whether a list starts with [1, 2]:

var r = _(1, 2, 3, 4, 5).startsWith([1, 2]);   // returns true

Example

The same using an array as base list:

var r = _.startsWith([1, 2, 3, 4, 5], [1, 2]); // returns true

Example

Checks a string:

var r = _.startsWith("Cookie", "C"); // returns true

See also..

  • endsWith() is the equivalent for the list's or string's end.

Comments

comments powered by Disqus

back to Overview

Functions