string-trim-spaces-only^5.3.1

No 3rd party dependencies. All dependencies and devDependencies, checked recursively, are Codsen packages.

Permalink to InstallationInstallation

Permalink to Quick TakeQuick Take

Permalink to ExamplesExamples

• 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

Purpose

trimSpaces() removes configurable whitespace from the start and end of a string. It returns both the trimmed string and the ranges removed from the original input. By default, it trims only ordinary spaces (U+0020).

import { trimSpaces } from "string-trim-spaces-only";

console.log(trimSpaces("  value   "));
// {
//   res: "value",
//   ranges: [[0, 2], [7, 10]]
// }

API — trimSpaces()

The main function trimSpaces() is imported like this:

The function accepts a required string and an optional, partial options object:

Passing a non-string first argument throws an error.

Options

Here are all defaults in one place for copying:

Result

The function returns a plain object:

Range offsets use JavaScript UTF-16 string indexes. If no characters are removed, ranges is an empty array. If both ends are trimmed, the leading range comes first.

The ranges can be combined with other Ranges ecosystem operations before the edits are applied:

import { rApply } from "ranges-apply";
import { trimSpaces } from "string-trim-spaces-only";

const input = "  value   ";
const { ranges } = trimSpaces(input);

console.log(rApply(input, ranges));
// => "value"

opts.classicTrim

Set classicTrim to true to use JavaScript’s complete String.trim() whitespace set while still receiving the removed ranges. In this mode, cr, lf, tab, space, and nbsp are ignored.

trimSpaces(" \t\n value \r\n ", { classicTrim: true });
// {
//   res: "value",
//   ranges: [[0, 4], [9, 13]]
// }

If you need only the resulting string, use String.trim() directly. Use this package when you need a custom trim set or the corresponding ranges.

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:

Permalink to changelogChangelog