first

Return the first n UTF-16 code units of a string.

Installation

npm install @stdlib/string-base-first

Usage

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

first( str, n )

Returns the first n UTF-16 code units of a string.

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

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

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

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

Examples

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

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

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

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

See Also

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

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.