@stdlib/string-base-remove-first-grapheme-cluster v0.2.1

removeFirstGraphemeCluster

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

Installation

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

Usage

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

removeFirstGraphemeCluster( str, n )

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

var out = removeFirstGraphemeCluster( 'last man standing', 1 );
// returns 'ast man standing'

out = removeFirstGraphemeCluster( 'Hidden Treasures', 1 );
// returns 'idden Treasures'

out = removeFirstGraphemeCluster( 'foo bar', 5 );
// returns 'ar'

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

Examples

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

var str = removeFirstGraphemeCluster( 'presidential election', 1 );
// returns 'residential election'

str = removeFirstGraphemeCluster( 'JavaScript', 1 );
// returns 'avaScript'

str = removeFirstGraphemeCluster( 'The Last of the Mohicans', 5 );
// returns 'ast of the Mohicans'

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

str = removeFirstGraphemeCluster( '🐶🐮🐷🐰🐸', 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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.