nextGraphemeClusterBreak

Return the next extended grapheme cluster break in a string after a specified position.

Installation

npm install @stdlib/string-next-grapheme-cluster-break

Usage

var nextGraphemeClusterBreak = require( '@stdlib/string-next-grapheme-cluster-break' );

nextGraphemeClusterBreak( string[, fromIndex] )

Returns the next extended grapheme cluster break in a string after a specified position.

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

By default, the function searches for a grapheme cluster break starting from the first index. To specify an alternative starting search index, provide a fromIndex argument.

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

Notes

• If string is an empty string, the function returns -1 irrespective of fromIndex.
• If an extended grapheme cluster break 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 nextGraphemeClusterBreak = require( '@stdlib/string-next-grapheme-cluster-break' );

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

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

out = nextGraphemeClusterBreak( 'अनुच्छेद', 1 );
// returns 3

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

See Also

• @stdlib/string-next-grapheme-cluster-break-cli: CLI package for use as a command-line utility.
• @stdlib/string-num-grapheme-clusters: return the number of grapheme clusters in a string.
• @stdlib/string-prev-grapheme-cluster-break: return the previous extended grapheme cluster break in a string before a specified position.

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.