ltrim

Trim whitespace characters from the beginning of a string.

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/string-left-trim-cli

Usage

Usage: ltrim [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Notes

• If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

  # Not escaped...
  $ echo -n $'   foo   \n   bar   ' | ltrim --split /\r?\n/
  
  # Escaped...
  $ echo -n $'   foo   \n   bar   ' | ltrim --split /\\r?\\n/

• The implementation ignores trailing delimiters.

Examples

$ ltrim '  beep boop'
beep boop

To use as a standard stream,

$ echo -n '  beep boop' | ltrim
beep boop

By default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

$ echo -n '   foo   \t   bar   \t   baz   ' | ltrim --split '\t'
foo   
bar   
baz   

See Also

• @stdlib/string-left-trim: trim whitespace characters from the beginning of a string.
• @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.