@stdlib/string-left-trim-n NPM

ltrimN

Trim n characters from the end of a string.

Installation

npm install @stdlib/string-left-trim-n

Usage

var ltrimN = require( '@stdlib/string-left-trim-n' );

ltrimN( str, n[, chars] )

Trims n characters from the beginning of a string.

var str = '  foo  ';
var out = ltrimN( str, str.length );
// returns 'foo  '

out = ltrimN( str, 1 );
// returns ' foo  '

By default, the function trims whitespace characters. To trim a different set of characters instead, provide a string or an array of characters to trim:

var str = '🐶🐶🐶 Animals 🐶🐶🐶';
var out = ltrimN( str, str.length, [ '🐶', ' ' ] );
// returns 'Animals 🐶🐶🐶'

out = ltrimN( str, str.length, '🐶 ' );
// returns 'Animals 🐶🐶🐶'

Examples

var ltrimN = require( '@stdlib/string-left-trim-n' );

var out = ltrimN( '   Whitespace   ', 3 );
// returns 'Whitespace   '

out = ltrimN( '\t\t\tTabs\t\t\t', 2 );
// returns '\tTabs\t\t\t'

out = ltrimN( '~~~CUSTOM~~~', 3, '~' );
// returns 'CUSTOM~~~'

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.