222 lines
4.8 KiB
Markdown
222 lines
4.8 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# endsWith
|
|
|
|
> Test if a string ends with the characters of another string.
|
|
|
|
<section class="intro">
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<section class="usage">
|
|
|
|
## 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
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```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
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
* * *
|
|
|
|
<section class="cli">
|
|
|
|
## CLI
|
|
|
|
<section class="usage">
|
|
|
|
### Usage
|
|
|
|
```text
|
|
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/'.
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
### 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.
|
|
|
|
</section>
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
### 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
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
</section>
|
|
|
|
<!-- /.cli -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
* * *
|
|
|
|
## See Also
|
|
|
|
- <span class="package-name">[`@stdlib/string/starts-with`][@stdlib/string/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
|
|
|
|
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
|
|
|
<!-- <related-links> -->
|
|
|
|
[@stdlib/string/starts-with]: https://github.com/stdlib-js/string/tree/main/starts-with
|
|
|
|
<!-- </related-links> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|