firstGraphemeCluster

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

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 '🐶🐮🐷🐰🐸'

---

See Also

• @stdlib/string/base/first: return the first UTF-16 code unit of a string.
• @stdlib/string/base/first-code-point: return the first Unicode code point of a string.
• @stdlib/string/base/last-grapheme-cluster: return the last grapheme cluster (i.e., user-perceived character) of a string.
• @stdlib/string/base/remove-first-grapheme-cluster: remove the first grapheme cluster (i.e., user-perceived character) of a string.
• @stdlib/string/first: return the first character(s) of a string.