Slashes
Add or remove backslashes (escape or unescape).
Getting started
import { addSlashes, removeSlashes } from 'slashes';
addSlashes(`foo\nbar`);
removeSlashes(`foo\\nbar`);
Adding slashes
By default, addSlashes
will escape the following JSON-unsafe characters.
- Backspace (
\b
) - Form Feed (
\f
) - Newline (
\n
) - Carriage Return (
\r
) - Horizontal Tab (
\t
) - Vertical Tab (
\v
) - Null (
\0
) - Double Quote (
"
) - Backslash (
\
)
const encoded = addSlashes(`\n`);
This default character set is the characters which cannot be included in a JSON string literal.
const jsonString = `{ "value": "${encoded}" }`;
Custom encoding
Escape encoding can be customized using the getEscaped
option.
The following is the default, equivalent to not setting the getEscaped
option.
import { getEscapedJsonUnsafe } from 'slashes';
addSlashes(`\n`, { getEscaped: getEscapedJsonUnsafe });
Included getEscaped
implementations:
getEscapedJsonUnsafe
- (Default) Encode characters which cannot be used between quotes in a JSON string.getEscapedAny
- Encode ANY character to a single letter (eg. \n
) or an ES5 Unicode (eg. \u0100
) escape sequence.
A custom getEscaped
receives one character (may be unicode) at a time. It can return true
to use the standard escape sequence, false
to not escape the character, or a string to provide a custom escape sequence (must begin with a backslash).
getEscaped(character: string): boolean | `\\${string}` | ''
Removing slashes
The removeSlashes
function will always remove one layer of slashes.
removeSlashes(`\\n`);
removeSlashes('\\u{a}');
removeSlashes('\u000a');
removeSlashes('\x0a');
removeSlashes('\12');
removeSlashes(`\\a`);
Custom decoding
Although it should generally not be necessary because all escapes are automatically handled, escape decoding can be customized using the getUnescaped
option.
The following is the default, equivalent to not setting the getUnescaped
option.
import { getUnescapedAny } from 'slashes';
removeSlashes('\\n', { getUnescaped: getUnescapedAny });
Included getUnescaped
implementations:
getUnescapedAny
- Decode ANY Javascript supported escape sequence.
A custom getUnescaped
implementation receives the escape sequence as the first argument, and the escape sequence code point number or null
(for single letter escape sequences) as the second argument. It can return true
to use standard decoding, false
to treat the sequence as invalid (only removes the leading backslash), or a string to provide a custom decoded value for the escape sequence.
getUnescaped(sequence: `\\${string}`, code: number | null): boolean | string