
Security News
Crates.io Implements Trusted Publishing Support
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
json-stringify-deterministic
Advanced tools
deterministic version of JSON.stringify() so you can get a consistent hash from stringified results.
Deterministic version of
JSON.stringify()
, so you can get a consistent hash from stringified results.
Similar to json-stable-stringify but:
.toJSON
(such as RegExp
).npm install json-stringify-deterministic --save
const stringify = require('json-stringify-deterministic')
const obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 }
console.log(stringify(obj))
// => {"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
Required
Type: object
The input object
to be serialized.
Type: function
Default: JSON.stringify
Determinate how to stringify primitives values.
Type: boolean
Default: false
Determinate how to resolve cycles.
Under true
, when a cycle is detected, [Circular]
will be inserted in the node.
Type: function
Custom comparison function for object keys.
Your function opts.compare
is called with these parameters:
opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })
For example, to sort on the object key names in reverse order you could write:
const stringify = require('json-stringify-deterministic')
const obj = { c: 8, b: [{z: 6,y: 5,x: 4}, 7], a: 3 }
const objSerializer = stringify(obj, function (a, b) {
return a.key < b.key ? 1 : -1
})
console.log(objSerializer)
// => {"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:
const stringify = require('json-stringify-deterministic')
const obj = { d: 6, c: 5, b: [{ z: 3, y: 2, x: 1 }, 9], a: 10 }
const objtSerializer = stringify(obj, function (a, b) {
return a.value < b.value ? 1 : -1
})
console.log(objtSerializer)
// => {"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10}
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:
const stringify = require('json-stringify-deterministic')
const obj = { b: 1, a: { foo: 'bar', and: [1, 2, 3] } }
const objSerializer = stringify(obj, { space: ' ' })
console.log(objSerializer)
// => {
// "a": {
// "and": [
// 1,
// 2,
// 3
// ],
// "foo": "bar"
// },
// "b": 1
// }
Type: function
The replacer parameter is a function opts.replacer(key, value)
that behaves
the same as the replacer
from the core JSON object.
MIT © Kiko Beats.
FAQs
deterministic version of JSON.stringify() so you can get a consistent hash from stringified results.
We found that json-stringify-deterministic demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.
Research
/Security News
North Korean threat actors deploy 67 malicious npm packages using the newly discovered XORIndex malware loader.