@fav/text.trim
v1.0.2
Published
Removes leading and trailing white spaces or specified characters from a source string.
Downloads
15
Readme
@fav/text.trim
Removes leading and trailing white spaces or specified characters from a source string.
"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.
Install
To install from npm:
$ npm install --save @fav/text.trim
NOTE: npm < 2.7.0 does not support scoped package, but even old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/text.trim/
directory manually.
Usage
For Node.js:
var trim = require('@fav/text.trim');
trim(' abc '); // => 'abc'
trim('_-abc--_-', '_-'); // => 'abc'
For Web browsers:
<script src="fav.text.trim.min.js"></script>
<script>
var trim = fav.text.trim;
trim(' abc '); // => 'abc'
</script>
API
trim(source [, chars]) : string
Removes leading and trailing white spaces or chars from source.
NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.
Parameters:
| Parameter | Type | Description | |-----------|:------:|--------------------| | source | string | The source string. | | chars | string | The characters to be trimmed. (Optional, and white space in default.) |
Return:
The trimmed string.
Type: string
Checked
Node.js (4〜)
| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 | |:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|◯|◯|
io.js (1〜3)
| Platform | 1 | 2 | 3 | |:---------:|:------:|:------:|:------:| | macOS |◯|◯|◯| | Windows10 |◯|◯|◯| | Linux |◯|◯|◯|
Node.js (〜0.12)
| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 | |:---------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|
Web browsers
| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 | |:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:| | macOS |◯|◯ |◯ |◯| -- | -- | | Windows10 |◯|◯ |◯ | -- |◯|◯| | Linux |◯|◯ |◯ | -- | -- | -- |
License
Copyright (C) 2017-2018 Takayuki Sato
This program is free software under MIT License. See the file LICENSE in this distribution for more details.