first

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

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'