What is trim?
The trim npm package is a simple utility that provides string trimming functionality. It allows users to remove whitespace from both ends of a string, which is useful for cleaning up user input, formatting text, or preparing data for further processing.
What are trim's main functionalities?
Trimming whitespace from both ends of a string
This feature removes all whitespace from the beginning and end of the provided string, resulting in 'Hello World!' without the extra spaces.
" Hello World! ".trim()
Other packages similar to trim
lodash.trim
Lodash provides a trim function that removes whitespace from the beginning and end of a string. It is part of the larger lodash library, which offers a wide range of utility functions for different types of data manipulation. Compared to the standalone trim package, lodash.trim comes with the overhead of the larger lodash library, but it benefits from the robustness and additional features that lodash offers.
string.prototype.trim
This package is a polyfill for the String.prototype.trim method, which is natively available in modern JavaScript environments. It ensures compatibility with older browsers that do not support the trim method. Unlike the trim package, which is a standalone utility, this package is specifically designed to polyfill the native method when it's not available.
trim
Trims string whitespace.
Installation
$ npm install trim
$ component install component/trim
API
### trim(str)
should trim leading / trailing whitespace.
trim(' foo bar ').should.equal('foo bar');
trim('\n\n\nfoo bar\n\r\n\n').should.equal('foo bar');
### .left(str)
should trim leading whitespace.
trim.left(' foo bar ').should.equal('foo bar ');
### .right(str)
should trim trailing whitespace.
trim.right(' foo bar ').should.equal(' foo bar');
Development
Run tests with
npx mocha
License
(The MIT License)
Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.