time-to-botec/squiggle/node_modules/@stdlib/string/trim/README.md

Trim

Trim whitespace characters from the beginning and end of a string.

Usage

var trim = require( '@stdlib/string/trim' );

trim( str )

Trims whitespace characters from the beginning and end of a string.

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

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 trim = require( '@stdlib/string/trim' );

var out = trim( '   Whitespace   ' );
// returns 'Whitespace'

out = trim( '\t\t\tTabs\t\t\t' );
// returns 'Tabs'

out = trim( '\n\n\nNew Lines\n\n\n' );
// returns 'New Lines'

---

CLI

Usage

Usage: trim [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   ' | trim --split /\r?\n/
  
  # Escaped...
  $ echo -n $'   foo   \n   bar   ' | trim --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ trim '    beep boop  '
beep boop

To use as a standard stream,

$ echo -n '    beep boop  ' | trim
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   ' | trim --split '\t'
foo
bar
baz

---

See Also

• @stdlib/string/left-trim: trim whitespace characters from the beginning of a string.
• @stdlib/string/pad: pad a string.
• @stdlib/string/right-trim: trim whitespace characters from the end of a string.