# endsWith
> Test if a string ends with the characters of another string.
## Usage
```javascript
var endsWith = require( '@stdlib/string/ends-with' );
```
#### endsWith( str, search\[, len] )
Tests if a `string` ends with the characters of another `string`.
```javascript
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`).
```javascript
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`.
```javascript
var str = 'beep boop';
var bool = endsWith( str, '' );
// returns true
```
## Examples
```javascript
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
### Usage
```text
Usage: ends-with [options] --search= []
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][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# Not escaped...
$ echo -n $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\r?\n/
# Escaped...
$ echo -n $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ ends-with --search=ep beep
true
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'boop' | ends-with --search=ep
false
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n 'Hello, World!\tBeep Boop' | ends-with --search=Boop --split '\t'
false
true
```
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/string/starts-with]: https://github.com/stdlib-js/string/tree/main/starts-with