README
endsWith
Test if a string ends with the characters of another string.
Installation
npm install @stdlib/string-ends-with
Usage
var endsWith = require( '@stdlib/string-ends-with' );
endsWith( str, search[, len] )
Tests if a string ends with the characters of another string.
var str = 'Remember the story I used to tell you when you were a boy?';
var bool = endsWith( str, 'boy?' );
// returns true
bool = endsWith( str, 'Boy?' );
// returns false
To search for a match at the end of a substring, provide a len argument. If len is positive, the function restricts the search to a substring with length len, beginning with the leftmost character. If len is negative, len indicates to ignore the last len characters (equivalent of str.length + len).
var str = 'To be, or not to be, that is the question.';
var bool = endsWith( str, 'to be', 19 );
// returns true
bool = endsWith( str, 'to be', -23 );
// returns true
If provided an empty search string, the function always returns true.
var str = 'beep boop';
var bool = endsWith( str, '' );
// returns true
Examples
var endsWith = require( '@stdlib/string-ends-with' );
var bool;
var str;
str = 'Fair is foul, and foul is fair, hover through fog and filthy air';
bool = endsWith( str, 'air' );
// returns true
bool = endsWith( str, 'fair' );
// returns false
bool = endsWith( str, 'fair', 30 );
// returns true
bool = endsWith( str, 'fair', -34 );
// returns true
CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-ends-with
Usage
Usage: ends-with [options] --search=<string> [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--search string Search string.
--len int Substring length.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
Notes
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n