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}" }`;
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.
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`);
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 });
The getUnescapedAny
implementation is the only one included.