time-to-botec/squiggle/node_modules/@stdlib/string/left-trim

Left Trim

Trim whitespace characters from the beginning of a string.

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'

---

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/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.