@stdlib/string-base-trim
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

trim

NPM version Build Status Coverage Status

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

Installation

npm install @stdlib/string-base-trim

Usage

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

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-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/string-base-trim

Homepage

stdlib.io

Weekly Downloads

8,555

Version

0.2.2

License

Apache-2.0

Unpacked Size

35.9 kB

Total Files

15

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser