json-stringify-deterministic

Deterministic version of JSON.stringify(), so you can get a consistent hash from stringified results.

Similar to json-stable-stringify but:

• No Dependencies. Minimal as possible.
• Better cycles detection.
• Support serialization for object without .toJSON (such as RegExp).
• Provides built-in TypeScript declarations.

Install

1npm install json-stringify-deterministic --save

Usage

1const stringify = require('json-stringify-deterministic')
2const obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 }
3
4console.log(stringify(obj))
5// => {"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}

API

stringify(<obj>, [opts])

obj

Required
Type: object

The input object to be serialized.

opts

opts.stringify

Type: function Default: JSON.stringify

Determinate how to stringify primitives values.

opts.cycles

Type: boolean Default: false

Determinate how to resolve cycles.

Under true, when a cycle is detected, [Circular] will be inserted in the node.

opts.compare

Type: function

Custom comparison function for object keys.

Your function opts.compare is called with these parameters:

1opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })

For example, to sort on the object key names in reverse order you could write:

1const stringify = require('json-stringify-deterministic')
2
3const obj = { c: 8, b: [{z: 6,y: 5,x: 4}, 7], a: 3 }
4const objSerializer = stringify(obj, function (a, b) {
5  return a.key < b.key ? 1 : -1
6})
7
8console.log(objSerializer)
9// => {"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3}

Or if you wanted to sort on the object values in reverse order, you could write:

1const stringify = require('json-stringify-deterministic')
2
3const obj = { d: 6, c: 5, b: [{ z: 3, y: 2, x: 1 }, 9], a: 10 }
4const objtSerializer = stringify(obj, function (a, b) {
5  return a.value < b.value ? 1 : -1
6})
7
8console.log(objtSerializer)
9// => {"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10}

opts.space

Type: string
Default: ''

If you specify opts.space, it will indent the output for pretty-printing.

Valid values are strings (e.g. {space: \t}). For example:

1const stringify = require('json-stringify-deterministic')
2
3const obj = { b: 1, a: { foo: 'bar', and: [1, 2, 3] } }
4const objSerializer = stringify(obj, { space: '  ' })
5console.log(objSerializer)
6// => {
7//   "a": {
8//     "and": [
9//       1,
10//       2,
11//       3
12//     ],
13//     "foo": "bar"
14//   },
15//   "b": 1
16// }

opts.replacer

Type: function

The replacer parameter is a function opts.replacer(key, value) that behaves the same as the replacer from the core JSON object.

Related

• sort-keys-recursive: Sort the keys of an array/object recursively.

License

MIT © Kiko Beats.