@stdlib/string-trim

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

Usage no npm install needed!

<script type="module">
  import stdlibStringTrim from 'https://cdn.skypack.dev/@stdlib/string-trim';
</script>

README

Trim

NPM version Build Status Coverage Status dependencies

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

Installation

npm install @stdlib/string-trim

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

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/string-trim

Usage

Usage: trim [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ trim '    beep boop  '
beep boop

To use as a standard stream,

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

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.