ltrim

Trim whitespace characters from the beginning of a string.

Installation

npm install @stdlib/string-left-trim

Usage

var ltrim = require( '@stdlib/string-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-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'

See Also

• @stdlib/string-left-trim-cli: CLI package for use as a command-line utility.
• @stdlib/string-trim: trim whitespace characters from the beginning and end of a string.
• @stdlib/string-right-trim: trim whitespace characters from the end 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.