https://github.com/commenthol/serialize-to-js
serialize objects to javascript
https://github.com/commenthol/serialize-to-js
javascript serialize-objects
Last synced: 2 months ago
JSON representation
serialize objects to javascript
- Host: GitHub
- URL: https://github.com/commenthol/serialize-to-js
- Owner: commenthol
- License: mit
- Created: 2015-04-18T20:07:02.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T02:37:25.000Z (over 1 year ago)
- Last Synced: 2025-04-17T15:13:27.625Z (3 months ago)
- Topics: javascript, serialize-objects
- Language: JavaScript
- Size: 77.1 KB
- Stars: 26
- Watchers: 4
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serialize-to-js
> serialize objects to javascript
[](https://www.npmjs.com/package/serialize-to-js/)
[](https://github.com/commenthol/serialize-to-js/actions/workflows/ci.yml?query=branch%3Amaster)
Serialize objects into a string while checking circular structures and respecting references.
The following Objects are supported
- String
- Number
- Boolean
- Object
- Array
- RegExp
- Error
- Date
- Buffer
- Int8Array, Uint8Array, Uint8ClampedArray
- Int16Array, Uint16Array
- Int32Array, Uint32Array, Float32Array
- Float64Array
- Set
- Map
## Table of Contents
* [Methods](#methods)
* [serialize](#serialize)
* [Contribution and License Agreement](#contribution-and-license-agreement)
* [License](#license)
## Methods
### serialize
`serialize(source, opts, opts.ignoreCircular, opts.reference)`
serializes an object to javascript
#### Example - serializing regex, date, buffer, ...
```js
const serialize = require('serialize-to-js')
const obj = {
str: 'var a = 0 > 1',
num: 3.1415,
bool: true,
nil: null,
undef: undefined,
obj: { foo: 'bar' },
arr: [1, '2'],
regexp: /^test?$/,
date: new Date(),
buffer: new Buffer('data'),
set: new Set([1, 2, 3]),
map: new Map([['a': 1],['b': 2]])
}
console.log(serialize(obj))
//> '{str: "\u003Cscript\u003Evar a = 0 \u003E 1\u003C\u002Fscript\u003E",
//> num: 3.1415, bool: true, nil: null, undef: undefined,
//> obj: {foo: "bar"}, arr: [1, "2"], regexp: new RegExp("^test?$", ""),
//> date: new Date("2019-12-29T10:37:36.613Z"),
//> buffer: Buffer.from("ZGF0YQ==", "base64"), set: new Set([1, 2, 3]),
//> map: new Map([["a", 1], ["b", 2]])}'
```
#### Example - serializing while respecting references
```js
var serialize = require('serialize-to-js')
var obj = { object: { regexp: /^test?$/ } };
obj.reference = obj.object;
var opts = { reference: true };
console.log(serialize(obj, opts));
//> {object: {regexp: /^test?$/}}
console.log(opts.references);
//> [ [ '.reference', '.object' ] ]
```
**Parameters**
**source**: `Object | Array | function | Any`, source to serialize
**opts**: `Object`, options
**opts.ignoreCircular**: `Boolean`, ignore circular objects
**opts.reference**: `Boolean`, reference instead of a copy (requires post-processing of opts.references)
**opts.unsafe**: `Boolean`, do not escape chars `<>/`
**Returns**: `String`, serialized representation of `source`
## Contribution and License Agreement
If you contribute code to this project, you are implicitly allowing your
code to be distributed under the MIT license. You are also implicitly
verifying that all code is your original work or correctly attributed
with the source of its origin and licence.
## License
Copyright (c) 2016- commenthol (MIT License)
See [LICENSE][] for more info.
[LICENSE]: ./LICENSE