Installation
Quick Take
Examples
- Include carriage returns in the configured trim set
- Trim every JavaScript whitespace character
- Trim tabs but preserve ordinary spaces at the edges
- Include line feeds in the configured trim set
- Preserve non-space whitespace at the trimmed boundaries
- Include raw non-breaking spaces in the configured trim set
- Return an empty ranges array when the value needs no trimming
- Include tabs in the configured trim set
API — trimSpaces()
The main function trimSpaces() is imported like this:
It’s a function which takes two input arguments:
| Input argument | Type | Obligatory | Description |
|---|---|---|---|
inputType: String Obligatory: yes | |||
input | String | yes | Input string you want to trim some way |
optsType: Plain object Obligatory: no | |||
opts | Plain object | no | An Optional Options Object. |
The Optional Options Object has the following shape:
| Key | Type | Default | Description |
|---|---|---|---|
classicTrimType: Boolean Default: false | |||
classicTrim | Boolean | false | If set to true, trimming becomes the same as String.trim(). |
crType: Boolean Default: false | |||
cr | Boolean | false | Trim the carriage returns (CR)? |
lfType: Boolean Default: false | |||
lf | Boolean | false | Trim the line breaks (LF)? |
tabType: Boolean Default: false | |||
tab | Boolean | false | Trim tabs? |
spaceType: Boolean Default: true | |||
space | Boolean | true | Trim spaces? |
nbspType: Boolean Default: false | |||
nbsp | Boolean | false | Trim raw non-breaking spaces? |
Here are all defaults in one place for copying:
The function will return a plain object:
| Key | Type | Description |
|---|---|---|
resType: String or zero or more characters | ||
res | String or zero or more characters | Result string after trimming. |
rangesType: Array of zero or more arrays | ||
ranges | Array of zero or more arrays | If anything was trimmed, each slice range is added into this array. |
ranges from the output can be further used in any Ranges ecosystem libraries to enable composable string operations.
API — defaults
You can import defaults:
It's a plain object:
The main function calculates the options to be used by merging the options you passed with these defaults.
API — version
You can import version:
opts.classicTrim
String.trim() returns string but sometimes you need just ranges of what would be trimmed, to merge them into compiled ranges array and to process later, along everything else. In those cases, use opts.classicTrim. If you need just string value, it’s not worth to use this function as a substitute for String.trim() for performance reasons.