serialize-to-js

serialize objects to javascript

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

Note: Version >3.0.0 has moved the serializeToModule method into its own package at serialize-to-module

Migrating from 2.x to 3.x for serialize:

// v2.x
const serialize = require('serialize-to-js').serialize
// >v3.x
const serialize = require('serialize-to-js')

Table of Contents

• Methods
  • serialize
• Contribution and License Agreement
• License

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')
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: Buffer.from('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')
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

serializeToModule

The serializeToModule has been moved to it`s own repository at serialize-to-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.