@stdlib/string-base-first-grapheme-cluster NPM

firstGraphemeCluster

Return the first n grapheme clusters (i.e., user-perceived characters) of a string.

Installation

npm install @stdlib/string-base-first-grapheme-cluster

Usage

var firstGraphemeCluster = require( '@stdlib/string-base-first-grapheme-cluster' );

firstGraphemeCluster( str, n )

Returns the first n grapheme clusters (i.e., user-perceived characters) of a string.

var out = firstGraphemeCluster( 'last man standing', 1 );
// returns 'l'

out = firstGraphemeCluster( 'Hidden Treasures', 1 );
// returns 'H'

out = firstGraphemeCluster( 'foo bar', 5 );
// returns 'foo b'

out = firstGraphemeCluster( 'foo bar', 10 );
// returns 'foo bar'

Examples

var firstGraphemeCluster = require( '@stdlib/string-base-first-grapheme-cluster' );

var str = firstGraphemeCluster( 'presidential election', 1 );
// returns 'p'

str = firstGraphemeCluster( 'JavaScript', 1 );
// returns 'J'

str = firstGraphemeCluster( 'The Last of the Mohicans', 5 );
// returns 'The L'

str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 2 );
// returns '🐶🐮'

str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );
// returns '🐶🐮🐷🐰🐸'

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.