nextCodePointIndex

Return the position of the next Unicode code point in a string after a specified position.

Installation

npm install @stdlib/string-next-code-point-index

Usage

var nextCodePointIndex = require( '@stdlib/string-next-code-point-index' );

nextCodePointIndex( string[, fromIndex] )

Returns the position of the next Unicode code point in a string after a specified position.

var out = nextCodePointIndex( 'last man standing' );
// returns 1

By default, the function searches for a Unicode code point starting from the first index. To specify an alternative starting search index, provide a fromIndex argument.

var out = nextCodePointIndex( 'last man standing', 4 );
// returns 5

Notes

• If string is an empty string, the function returns -1 irrespective of fromIndex.
• If a code point does not exist after fromIndex, the function returns -1.
• Note that fromIndex does not refer to a visual character position, but to an index in the ordered sequence of UTF-16 code units.

Examples

var nextCodePointIndex = require( '@stdlib/string-next-code-point-index' );

var out = nextCodePointIndex( 'last man standing', 4 );
// returns 5

out = nextCodePointIndex( 'presidential election', 8 );
// returns 9

out = nextCodePointIndex( '𐒻𐓟𐒻𐓟', 0 );
// returns 2

out = nextCodePointIndex( '🌷', 0 );
// returns -1

See Also

• @stdlib/string-next-code-point-index-cli: CLI package for use as a command-line utility.

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.