Socket
Socket
Sign inDemoInstall

serialize-to-js

Package Overview
Dependencies
41
Maintainers
1
Versions
24
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    serialize-to-js

serialize objects to javascript


Version published
Maintainers
1
Created

Readme

Source

serialize-to-js

serialize objects to javascript

NPM version Build Status

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
  • Float64Array

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

opts.unsafe: Boolean, do not escape chars <>/

Returns: String, serialized representation of source

deserialize

deserialize(str, [context])

deserialize a serialized object to javascript

NOTE: Deserialization uses new Function() for code evaluation which may be "harmful". SO NOW YOU ARE WARNED!

Uses safer-eval for deserialization.

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

context: (optional) pass context e.g. if requiring Buffer use {Buffer: Buffer}.

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.

opts.unsafe: Boolean, do not escape chars <>/

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.

Keywords

FAQs

Last updated on 01 Jan 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc