source: trip-planner-front/node_modules/serialize-javascript/README.md@ e29cc2e

Last change on this file since e29cc2e was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 5.6 KB
Line 
1Serialize JavaScript
2====================
3
4Serialize JavaScript to a _superset_ of JSON that includes regular expressions, dates and functions.
5
6[![npm Version][npm-badge]][npm]
7[![Dependency Status][david-badge]][david]
8![Test](https://github.com/yahoo/serialize-javascript/workflows/Test/badge.svg)
9
10## Overview
11
12The code in this package began its life as an internal module to [express-state][]. To expand its usefulness, it now lives as `serialize-javascript` — an independent package on npm.
13
14You're probably wondering: **What about `JSON.stringify()`!?** We've found that sometimes we need to serialize JavaScript **functions**, **regexps**, **dates**, **sets** or **maps**. A great example is a web app that uses client-side URL routing where the route definitions are regexps that need to be shared from the server to the client. But this module is also great for communicating between node processes.
15
16The string returned from this package's single export function is literal JavaScript which can be saved to a `.js` file, or be embedded into an HTML document by making the content of a `<script>` element.
17
18> **HTML characters and JavaScript line terminators are escaped automatically.**
19
20Please note that serialization for ES6 Sets & Maps requires support for `Array.from` (not available in IE or Node < 0.12), or an `Array.from` polyfill.
21
22## Installation
23
24Install using npm:
25
26```shell
27$ npm install serialize-javascript
28```
29
30## Usage
31
32```js
33var serialize = require('serialize-javascript');
34
35serialize({
36 str : 'string',
37 num : 0,
38 obj : {foo: 'foo'},
39 arr : [1, 2, 3],
40 bool : true,
41 nil : null,
42 undef: undefined,
43 inf : Infinity,
44 date : new Date("Thu, 28 Apr 2016 22:02:17 GMT"),
45 map : new Map([['hello', 'world']]),
46 set : new Set([123, 456]),
47 fn : function echo(arg) { return arg; },
48 re : /([^\s]+)/g,
49 big : BigInt(10),
50});
51```
52
53The above will produce the following string output:
54
55```js
56'{"str":"string","num":0,"obj":{"foo":"foo"},"arr":[1,2,3],"bool":true,"nil":null,"undef":undefined,"inf":Infinity,"date":new Date("2016-04-28T22:02:17.000Z"),"map":new Map([["hello","world"]]),"set":new Set([123,456]),"fn":function echo(arg) { return arg; },"re":new RegExp("([^\\\\s]+)", "g"),"big":BigInt("10")}'
57```
58
59Note: to produced a beautified string, you can pass an optional second argument to `serialize()` to define the number of spaces to be used for the indentation.
60
61### Automatic Escaping of HTML Characters
62
63A primary feature of this package is to serialize code to a string of literal JavaScript which can be embedded in an HTML document by adding it as the contents of the `<script>` element. In order to make this safe, HTML characters and JavaScript line terminators are escaped automatically.
64
65```js
66serialize({
67 haxorXSS: '</script>'
68});
69```
70
71The above will produce the following string, HTML-escaped output which is safe to put into an HTML document as it will not cause the inline script element to terminate:
72
73```js
74'{"haxorXSS":"\\u003C\\u002Fscript\\u003E"}'
75```
76
77> You can pass an optional `unsafe` argument to `serialize()` for straight serialization.
78
79### Options
80
81The `serialize()` function accepts an `options` object as its second argument. All options are being defaulted to `undefined`:
82
83#### `options.space`
84
85This option is the same as the `space` argument that can be passed to [`JSON.stringify`][JSON.stringify]. It can be used to add whitespace and indentation to the serialized output to make it more readable.
86
87```js
88serialize(obj, {space: 2});
89```
90
91#### `options.isJSON`
92
93This option is a signal to `serialize()` that the object being serialized does not contain any function or regexps values. This enables a hot-path that allows serialization to be over 3x faster. If you're serializing a lot of data, and know its pure JSON, then you can enable this option for a speed-up.
94
95**Note:** That when using this option, the output will still be escaped to protect against XSS.
96
97```js
98serialize(obj, {isJSON: true});
99```
100
101#### `options.unsafe`
102
103This option is to signal `serialize()` that we want to do a straight conversion, without the XSS protection. This options needs to be explicitly set to `true`. HTML characters and JavaScript line terminators will not be escaped. You will have to roll your own.
104
105```js
106serialize(obj, {unsafe: true});
107```
108
109#### `options.ignoreFunction`
110
111This option is to signal `serialize()` that we do not want serialize JavaScript function.
112Just treat function like `JSON.stringify` do, but other features will work as expected.
113
114```js
115serialize(obj, {ignoreFunction: true});
116```
117
118## Deserializing
119
120For some use cases you might also need to deserialize the string. This is explicitly not part of this module. However, you can easily write it yourself:
121
122```js
123function deserialize(serializedJavascript){
124 return eval('(' + serializedJavascript + ')');
125}
126```
127
128**Note:** Don't forget the parentheses around the serialized javascript, as the opening bracket `{` will be considered to be the start of a body.
129
130## License
131
132This software is free to use under the Yahoo! Inc. BSD license.
133See the [LICENSE file][LICENSE] for license text and copyright information.
134
135
136[npm]: https://www.npmjs.org/package/serialize-javascript
137[npm-badge]: https://img.shields.io/npm/v/serialize-javascript.svg?style=flat-square
138[david]: https://david-dm.org/yahoo/serialize-javascript
139[david-badge]: https://img.shields.io/david/yahoo/serialize-javascript.svg?style=flat-square
140[express-state]: https://github.com/yahoo/express-state
141[JSON.stringify]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
142[LICENSE]: https://github.com/yahoo/serialize-javascript/blob/main/LICENSE
Note: See TracBrowser for help on using the repository browser.