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

Notes

• In general, exercise caution when operating on substrings containing Unicode characters, as the visual character length may not equal the number of code points. For example,

  var len = '🏠'.length;
  // returns 2

• This function differs from String.prototype.endsWith in the following ways:

  • The function requires string values for the first and second arguments and requires that the len argument is an integer value.
  • The function does not clamp positive len values to the end of the input string.
  • Except when provided an empty search string, the function always returns false if len resolves to a starting search position which exceeds the bounds of the input string.

Examples

var endsWith = require( '@stdlib/string-ends-with' );

var str = 'Fair is foul, and foul is fair, hover through fog and filthy air';

var 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

See Also

• @stdlib/string-ends-with-cli: CLI package for use as a command-line utility.
• @stdlib/string-starts-with: test if a string starts with the characters of another string.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.