Package Exports
- @stdlib/string-trim
- @stdlib/string-trim/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-trim) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Trim
Trim whitespace characters from the beginning and end of a string.
Installation
npm install @stdlib/string-trimUsage
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
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-trimUsage
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
splitoption 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 boopTo use as a standard stream,
$ echo -n ' beep boop ' | trim
beep boopBy 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
bazNotice
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-2022. The Stdlib Authors.