locale-includes
v1.0.6
Published
String.prototype.includes() but using localeCompare.
Downloads
3,899
Maintainers
Readme
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 withinstring
.options
(object) - Optional
An object with some or all of the following properties:position
(number) - Default: 0
The position withinstring
at which to begin searching forsearchString
.locales
(string|array)
Passed through as thelocales
parameter toString.prototype.localeCompare()
.Any other property
Passed through in theoptions
parameter toString.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