@types/jsesc

When enabled, the output for arrays and objects is as compact as possible; it’s not formatted nicely.

true (enabled)

Example 1

import jsesc = require('jsesc');

jsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, { compact: true // this is the default }); // → '{'Ich \u2665 B\xFCcher':'foo \uD834\uDF06 bar'}'

jsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, { compact: false }); // → '{\n\t'Ich \u2665 B\xFCcher': 'foo \uD834\uDF06 bar'\n}'

jsesc([ 'Ich ♥ Bücher', 'foo 𝌆 bar' ], { compact: false }); // → '[\n\t'Ich \u2665 B\xFCcher',\n\t'foo \uD834\uDF06 bar'\n]'

When enabled, any astral Unicode symbols in the input are escaped using [ECMAScript 6 Unicode code point escape sequences](https://mathiasbynens.be/notes/javascript-escapes#unicode-code-point) instead of using separate escape sequences for each surrogate half. If backwards compatibility with ES5 environments is a concern, don’t enable this setting. If the json setting is enabled, the value for the es6 setting is ignored (as if it was false).

false (disabled)

Example 1

import jsesc = require('jsesc');

// By default, the es6 option is disabled: jsesc('foo 𝌆 bar 💩 baz'); // → 'foo \uD834\uDF06 bar \uD83D\uDCA9 baz'

// To explicitly disable it: jsesc('foo 𝌆 bar 💩 baz', { es6: false }); // → 'foo \uD834\uDF06 bar \uD83D\uDCA9 baz'

// To enable it: jsesc('foo 𝌆 bar 💩 baz', { es6: true }); // → 'foo \u{1D306} bar \u{1F4A9} baz'

When enabled, all the symbols in the output are escaped — even printable ASCII symbols. This setting also affects the output for string literals within arrays and objects.

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('lolwat"foo'bar', { escapeEverything: true }); // → '\x6C\x6F\x6C\x77\x61\x74\"\x66\x6F\x6F\'\x62\x61\x72' // → "\x6C\x6F\x6C\x77\x61\x74\"\x66\x6F\x6F\'\x62\x61\x72"

When the compact setting is disabled (false), the value of the indent option is used to format the output for arrays and objects. This setting has no effect on the output for strings.

'\t'

Example 1

import jsesc = require('jsesc');

jsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, { compact: false, indent: '\t' // this is the default }); // → '{\n\t'Ich \u2665 B\xFCcher': 'foo \uD834\uDF06 bar'\n}'

jsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, { compact: false, indent: ' ' }); // → '{\n 'Ich \u2665 B\xFCcher': 'foo \uD834\uDF06 bar'\n}'

jsesc([ 'Ich ♥ Bücher', 'foo 𝌆 bar' ], { compact: false, indent: ' ' }); // → '[\n 'Ich \u2665 B\xFCcher',\n\ t'foo \uD834\uDF06 bar'\n]'

It represents the current indentation level, i.e. the number of times the value of the indent option is repeated.

0

Example 1

import jsesc = require('jsesc');

jsesc(['a', 'b', 'c'], { compact: false, indentLevel: 1 }); // → '[\n\t\t'a',\n\t\t'b',\n\t\t'c'\n\t]'

jsesc(['a', 'b', 'c'], { compact: false, indentLevel: 2 }); // → '[\n\t\t\t'a',\n\t\t\t'b',\n\t\t\t'c'\n\t\t]'

When enabled, occurrences of [</script and </style](https://mathiasbynens.be/notes/etago) in the output are escaped as <\/script and <\/style, and [<!--](https://mathiasbynens.be/notes/etago#comment-8) is escaped as \x3C!-- (or \u003C!-- when the json option is enabled). This setting is useful when jsesc’s output ends up as part of a <script> or <style> element in an HTML document.

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('foobar', { isScriptContext: true }); // → 'foo<\/script>bar'

When enabled, the output is valid JSON. [Hexadecimal character escape sequences](https://mathiasbynens.be/notes/javascript-escapes#hexadecimal) and [the \v or \0 escape sequences](https://mathiasbynens.be/notes/javascript-escapes#single) are not used. Setting json: true implies quotes: 'double', wrap: true, es6: false, although these values can still be overridden if needed — but in such cases, the output won’t be valid JSON anymore.

**Note:** Using this option on objects or arrays that contain non-string values relies on JSON.stringify(). For legacy environments like IE ≤ 7, use [a JSON polyfill](http://bestiejs.github.io/json3/).

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('foo\x00bar\xFF\uFFFDbaz', { json: true }); // → '"foo\u0000bar\u00FF\uFFFDbaz"'

jsesc({ 'foo\x00bar\xFF\uFFFDbaz': 'foo\x00bar\xFF\uFFFDbaz' }, { json: true }); // → '{"foo\u0000bar\u00FF\uFFFDbaz":"foo\u0000bar\u00FF\uFFFDbaz"}'

jsesc([ 'foo\x00bar\xFF\uFFFDbaz', 'foo\x00bar\xFF\uFFFDbaz' ], { json: true }); // → '["foo\u0000bar\u00FF\uFFFDbaz","foo\u0000bar\u00FF\uFFFDbaz"]'

// Values that are acceptable in JSON but aren’t strings, arrays, or object // literals can’t be escaped, so they’ll just be preserved: jsesc([ 'foo\x00bar', [1, '©', { 'foo': true, 'qux': null }], 42 ], { json: true }); // → '["foo\u0000bar",[1,"\u00A9",{"foo":true,"qux":null}],42]' // Values that aren’t allowed in JSON are run through JSON.stringify(): jsesc([ undefined, -Infinity ], { json: true }); // → '[null,null]'

When enabled, any alphabetical hexadecimal digits in escape sequences as well as any hexadecimal integer literals (see the numbers option) in the output are in lowercase.

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('Ich ♥ Bücher', { lowercaseHex: true }); // → 'Ich \u2665 B\xfccher' // ^^

jsesc(42, { numbers: 'hexadecimal', lowercaseHex: true }); // → '0x2a' // ^^

When enabled, only a limited set of symbols in the output are escaped:

- U+0000 \0 - U+0008 \b - U+0009 \t - U+000A \n - U+000C \f - U+000D \r - U+005C \\ - U+2028 \u2028 - U+2029 \u2029 - whatever symbol is being used for wrapping string literals (based on the quotes option) - [lone surrogates](https://esdiscuss.org/topic/code-points-vs-unicode-scalar-values#content-14)

Note: with this option enabled, jsesc output is no longer guaranteed to be ASCII-safe.

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('foo\u2029bar\nbaz©qux𝌆flops', { minimal: false }); // → 'foo\u2029bar\nbaz©qux𝌆flops'

The value 'decimal' for the numbers option means that any numeric values are represented using decimal integer literals. Other valid options are binary, octal, and hexadecimal, which result in binary integer literals, octal integer literals, and hexadecimal integer literals, respectively.

'decimal'

Example 1

import jsesc = require('jsesc');

jsesc(42, { numbers: 'binary' }); // → '0b101010'

jsesc(42, { numbers: 'octal' }); // → '0o52'

jsesc(42, { numbers: 'decimal' }); // → '42'

jsesc(42, { numbers: 'hexadecimal' }); // → '0x2A'

The value 'single' for the quotes option means that any occurrences of ' in the input string are escaped as \', so that the output can be used in a string literal wrapped in single quotes. If you want to use the output as part of a string literal wrapped in double quotes, set the quotes option to 'double'. If you want to use the output as part of a template literal (i.e. wrapped in backticks), set the quotes option to 'backtick'.

'single'

Example 1

import jsesc = require('jsesc');

jsesc('Lorem ipsum "dolor" sit 'amet' etc.'); // → 'Lorem ipsum "dolor" sit \'amet\' etc.'

jsesc('Lorem ipsum "dolor" sit 'amet' etc.', { quotes: 'single' }); // → 'Lorem ipsum "dolor" sit \'amet\' etc.' // → "Lorem ipsum "dolor" sit \'amet\' etc."

jsesc('Lorem ipsum "dolor" sit 'amet' etc.', { quotes: 'double' }); // → 'Lorem ipsum \"dolor\" sit 'amet' etc.' // → "Lorem ipsum \"dolor\" sit 'amet' etc."

jsesc('Lorem ipsum "dolor" sit 'amet' etc.', { quotes: 'backtick' }); // → '\Lorem\\ ipsum "dolor" sit 'amet' etc.' // → "\Lorem\\ ipsum "dolor" sit 'amet' etc." // → \\\Lorem\` ipsum "dolor" sit 'amet' etc.`

// This setting also affects the output for arrays and objects: jsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, { quotes: 'double' }); // → '{"Ich \u2665 B\xFCcher":"foo \uD834\uDF06 bar"}'

jsesc([ 'Ich ♥ Bücher', 'foo 𝌆 bar' ], { quotes: 'double' }); // → '["Ich \u2665 B\xFCcher","foo \uD834\uDF06 bar"]'

When enabled, the output is a valid JavaScript string literal wrapped in quotes. The type of quotes can be specified through the quotes setting.

false (disabled)

Example 1

import jsesc = require('jsesc');

jsesc('Lorem ipsum "dolor" sit 'amet' etc.', { quotes: 'single', wrap: true }); // → ''Lorem ipsum "dolor" sit \'amet\' etc.'' // → "'Lorem ipsum "dolor" sit \'amet\' etc.'"

jsesc('Lorem ipsum "dolor" sit 'amet' etc.', { quotes: 'double', wrap: true }); // → '"Lorem ipsum \"dolor\" sit 'amet' etc."' // → ""Lorem ipsum \"dolor\" sit 'amet' etc.""