object-tojson
v3.0.0
Published
Turn a Javascript primitive into its "flat" representation. Aims to be equivalent to `JSON.parse(JSON.stringify(obj))`.
Downloads
329
Readme
object-tojson
Turn a Javascript primitive into its "flat" representation. Aims to be equivalent to
JSON.parse(JSON.stringify(obj))
.
Usage
Turn a Javascript primitive into its "flat" representation.
Aims to be equivalent to JSON.parse(JSON.stringify(obj))
.
Note that it will recursively visit all properties and attempt to call
toJSON
, before trying to parse the value. undefined
is not a valid
JSON value, so it will attempt to remove properties that resolve to this value,
unless it is an array element, in which case it resolves to null
.
var serialise = require('object-tojson')
serialise({
key: 'value',
arr: [undefined, null, true],
keyFn: {toJSON: function () { return 'valueFn' }}
}) // => {key: 'value', [null, null, true], keyFn: 'valueFn'}
// With replacer array
serialise({
key: 'value',
arr: [undefined, null, true],
keyFn: {toJSON: function () { return 'valueFn' }}
}, ['key', 0]) // => {key: 'value', [null, null, true]}
API
serialise(value, [replacer], [circular = false])
Recursively serialise value as JSON.strinfigy
, with optional replacer
.
replacer(key, value)
is called with the holder of vale
as the context (this
).
Return the replacement for value
from this function.
circular
controls whether circular references should throw an error like
JSON.stringify
or preserve a circular reference to the serialised result.
``
Install
npm install object-tojson