@stdlib/string-next-grapheme-cluster-break
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    nextGraphemeClusterBreak

    NPM version Build Status Coverage Status dependencies

    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

    CLI

    Installation

    To use the module as a general utility, install the module globally

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

    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

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    29

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    207 kB

    Total Files

    16

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser