@stdlib/string-num-grapheme-clusters

numGraphemeClusters

Return the number of grapheme clusters in a string.

Installation

npm install @stdlib/string-num-grapheme-clusters

Usage

var numGraphemeClusters = require( '@stdlib/string-num-grapheme-clusters' );

numGraphemeClusters( str )

Returns the number of grapheme clusters in a string.

var out = numGraphemeClusters( 'last man standing' );
// returns 17

out = numGraphemeClusters( 'Hidden Treasures' );
// returns 16

Examples

var numGraphemeClusters = require( '@stdlib/string-num-grapheme-clusters' );

var str = numGraphemeClusters( 'last man standing' );
// returns 17

str = numGraphemeClusters( '六书/六書' );
// returns 5

str = numGraphemeClusters( 'अनुच्छेद' );
// returns 5

str = numGraphemeClusters( '🌷' );
// returns 1

---

CLI

Installation

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

npm install -g @stdlib/string-num-grapheme-clusters

Usage

Usage: num-grapheme-clusters [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
  -l,    --lines               Analyze individual lines.

Examples

$ num-grapheme-clusters beep
4

To use as a standard stream,

$ echo -n 'beep\nboop🌷' | num-grapheme-clusters
10

$ echo -n 'beep\nboop🌷' | num-grapheme-clusters -l
4
5

---

See Also

• @stdlib/string/next-grapheme-cluster-break: return the next extended grapheme cluster break in a string after 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-2022. The Stdlib Authors.