@12joan/locale-includes

localeIncludes()

String.prototype.includes() but using localeCompare.

Install

npm i locale-includes

Syntax

localeIncludes(string, searchString[, options])

Parameters

• string (string)
  A string to be searched within.

• searchString (string)
  A string to be searched for within string.

• options (object) - Optional
  An object with some or all of the following properties:

  • position (number) - Default: 0
    The position within string at which to begin searching for searchString.

  • locales (string|array)
    Passed through as the locales parameter to String.prototype.localeCompare().

  • Any other property
    Passed through in the options parameter to String.prototype.localeCompare().

Return value

• (bool)
  Whether the search string is found anywhere within the given string or not.

Examples

import {localeIncludes} from `locale-includes`;

localeIncludes("Abcdef", "cde");
// true

localeIncludes("Abcdef", "cde", {position: 3});
// false

localeIncludes("àḃḉdÉf", "bCde", {usage: "search", sensitivity: "base"});
// true

See also

String.prototype.includes()
String.prototype.localeCompare()