# Trim
> Trim whitespace characters from the beginning and end of a string.
## Usage
```javascript
var trim = require( '@stdlib/string/trim' );
```
#### trim( str )
Trims whitespace characters from the beginning and end of a `string`.
```javascript
var out = trim( ' \t\t\n Beep \r\n\t ' );
// returns 'Beep'
```
## Notes
- Following [Unicode 6.3.0][unicode] 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
```javascript
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
```text
Usage: trim [options] []
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][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# 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
```bash
$ trim ' beep boop '
beep boop
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n ' beep boop ' | trim
beep boop
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n ' foo \t bar \t baz ' | trim --split '\t'
foo
bar
baz
```
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[unicode]: https://en.wikipedia.org/wiki/Unicode
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/string/left-trim]: https://github.com/stdlib-js/string/tree/main/left-trim
[@stdlib/string/pad]: https://github.com/stdlib-js/string/tree/main/pad
[@stdlib/string/right-trim]: https://github.com/stdlib-js/string/tree/main/right-trim