string-includes-x

string-includes-x

Determines whether one string may be found within another string.

module.exports ⇒ boolean ⏏

This method determines whether one string may be found within another string, returning true or false as appropriate.

Kind: Exported member
Returns: boolean - true if the given string is found anywhere within the search string; otherwise, false if not.
Throws:

• TypeError If target is null or undefined.
• TypeError If searchString is a RegExp.

Param	Type	Description
string	string	The target string.
searchString	string	A string to be searched for within the target string.
[position]	number	The position within the string at which to begin searching for searchString.(defaults to 0).

Example

import strIncludes from 'string-includes-x';

const str = 'To be, or not to be, that is the question.';

includes(str, 'To be'); // true
includes(str, 'question'); // true
includes(str, 'nonexistent'); // false
includes(str, 'To be', 1); // false
includes(str, ('TO BE'); // false