nextGraphemeClusterBreak
Return the next extended grapheme cluster break in a string after a specified position.
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 offromIndex
. - 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
CLI
Usage
Usage: next-grapheme-cluster-break [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--from index Starting search position in string. Default: 0.
Examples
$ next-grapheme-cluster-break --from=1 अनुच्छेद
3
To use as a standard stream,
$ echo -n 'अनुच्छेद' | next-grapheme-cluster-break --from=1
3