Package Exports
- serialize-to-js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serialize-to-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
serialize-to-js
serialize objects to javascript
Serialize objects into a require-able module 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
- Float64Arra
Table of Contents
Methods
serialize
serialize(source, opts, opts.ignoreCircular, opts.reference)
serializes an object to javascript
Example - serializing regex, date, buffer, ...
var serialize = require('serialize-to-js').serialize;
var obj = {
str: '<script>var a = 0 > 1</script>',
num: 3.1415,
bool: true,
nil: null,
undef: undefined,
obj: { foo: 'bar' },
arr: [1, '2'],
regexp: /^test?$/,
date: new Date(),
buffer: new Buffer('data'),
}
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: /^test?$/, date: new Date("2016-04-15T16:22:52.009Z"), buffer: new Buffer('ZGF0YQ==', 'base64')}Example - serializing while respecting references
var serialize = require('serialize-to-js').serialize;
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)
Returns: String, serialized representation of source
deserialize
deserialize(str)
deserialize a serialized object to javascript
Example - deserializing regex, date, ...
var str = '{obj: {foo: "bar"}, arr: [1, "2"], regexp: /^test?$/, date: new Date("2016-04-15T16:22:52.009Z")}'
var res = deserialize(str)
console.log(res)
//> { obj: { foo: 'bar' },
//> arr: [ 1, '2' ],
//> regexp: /^test?$/,
//> date: Sat Apr 16 2016 01:22:52 GMT+0900 (JST) }Parameters
str: String, string containing serialized data
Returns: Any, deserialized data
serializeToModule
serializeToModule(source, opts, opts.ignoreCircular, opts.reference, opts.comment, opts.beautify)
serialize to a module which can be requireed.
Example - serializing while respecting references
var serialTM = require('serialize-to-js').serializeToModule;
var obj = { object: { regexp: /^test?$/ } };
obj.reference = obj.object;
console.log(serialTM(obj, { reference: true }));
//> var m = module.exports = {
//> object: {
//> regexp: /^test?$/
//> }
//> };
//> m.reference = m.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.comment: Boolean, add a comments - useful for linting tools e.g. using 'eslint-disable'
opts.beautify: Boolean | Object, beautify output - default is false. If Object then use je-beautify options.
Returns: String, serialized representation of source as module
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.