Skip to content
Object serialization for JavaScript - readable & JS-compatible
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
test
.travis.yml
LICENSE
README.md Update README.md Jul 28, 2014
index.js
package.json

README.md

serialize-js

Build Status

What's this?

Small serialization helper for those who wants to get JS representation of object but gets only this dirty JSON.

Why does it exist?

Sometimes it's useful to serialize object into the JS user-readable representation but the only option you have is JSON which adds all this damn quotes around any keys (incl. valid identifiers), indents entire contents of any objects/arrays etc.

This small serializer allows you to overcome that and get pretty representations, just as you would write it with own hands in code:

objJSON.stringify(obj, null, 2)serialize(obj)
{a: 1}
{
  "a": 1
}
{a: 1}
{a: 1, b: 2}
{
  "a": 1,
  "b": 2
}
{a: 1, b: 2}
{a: 1, b: 2, c: 3}
{
  "a": 1,
  "b": 2,
  "c": 3
}
{
  a: 1,
  b: 2,
  c: 3
}
[{a: 1, b: 2, c: 3, '-': '+'}]
[
  {
    "a": 1,
    "b": 2,
    "c": 3,
    "-": "+"
  }
]
[{
  a: 1,
  b: 2,
  c: 3,
  "-": "+"
}]
[{a: 1}, {b: 2}]
[
  {
    "a": 1
  },
  {
    "b": 2
  }
]
[
  {a: 1},
  {b: 2}
]

How can I customize the output?

You can optionally pass options object as second argument (serialize(obj, { /*...options...*/ })).

Possible options are below:

initialIndent

Type: Number|String Default: ''

Initial indentation of output (generated indentation will be relative to this one). It can be either number of spaces or explicit string.

indent

Type: Number|String Default: 2

Indentation to be used for nested representations. It can be either number of spaces or explicit string (like '\t').

forceJSON

Type: Boolean Default: false

If set to true, generates JSON-compatible output (all the keys are wrapped with quotes, but indentation is still optimized).

Something went wrong with that request. Please try again.