ltrim

Trim whitespace characters from the beginning of a string.

Usage

var ltrim = require( '@stdlib/string/base/left-trim' );

ltrim( str )

Trims whitespace from the beginning of a string.

var out = ltrim( ' \r\n\t  Beep \t\t\n  ' );
// returns 'Beep \t\t\n  '

Notes

Following Unicode 6.3.0 and later, "whitespace" is defined as the following characters:
- \f
- \n
- \r
- \t
- \v
- \u0020
- \u00a0
- \u1680
- \u2000-\u200a
- \u2028
- \u2029
- \u202f
- \u205f
- \u3000
- \ufeff

Examples

var ltrim = require( '@stdlib/string/base/left-trim' );

var str = ltrim( '   Whitespace   ' );
// returns 'Whitespace   '

str = ltrim( '\t\t\tTabs\t\t\t' );
// returns 'Tabs\t\t\t'

str = ltrim( '\n\n\nNew Lines\n\n\n' );
// returns 'New Lines\n\n\n'