serialize-to-js

WebJar for serialize-to-js

License	MIT
Categories	JavaScript Languages
GroupId	org.webjars.npm
ArtifactId	serialize-to-js
Last Version	1.2.2
Release Date	Feb 26, 2019
Type	jar
Description	serialize-to-js WebJar for serialize-to-js
Project URL	http://webjars.org
Source Code Management	https://github.com/commenthol/serialize-to-js

Download serialize-to-js

Filename	Size
serialize-to-js-1.2.2.pom
serialize-to-js-1.2.2.jar	11 KB
serialize-to-js-1.2.2-sources.jar	22 bytes
serialize-to-js-1.2.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/serialize-to-js/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>serialize-to-js</artifactId>
    <version>1.2.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/serialize-to-js/
implementation 'org.webjars.npm:serialize-to-js:1.2.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/serialize-to-js/
implementation ("org.webjars.npm:serialize-to-js:1.2.2")

Apache Buildr

'org.webjars.npm:serialize-to-js:jar:1.2.2'

Apache Ivy

<dependency org="org.webjars.npm" name="serialize-to-js" rev="1.2.2">
  <artifact name="serialize-to-js" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='serialize-to-js', version='1.2.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "serialize-to-js" % "1.2.2"

Leiningen

[org.webjars.npm/serialize-to-js "1.2.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : js-beautify	jar	[1.8.9,2)
org.webjars.npm : safer-eval	jar	[1.3.0,2)

Project Modules

There are no modules declared in this project.

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
• Set
• Map

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, ...

const serialize = require('serialize-to-js')
const 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'),
  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

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.

Versions

Version
1.2.2 Feb 26, 2019