# json-stringify-deterministic
> Deterministic JSON.stringify with sorted keys for consistent hashes and stable cache keys.
Latest version **1.0.16** (published 2026-08-03) · MIT license · 0 weekly downloads
## Install
```sh
npm install json-stringify-deterministic
pnpm add json-stringify-deterministic
yarn add json-stringify-deterministic
bun add json-stringify-deterministic
```
## Health
**Score 65/100 (B)** — status: active.
Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.
Warnings: low downloads; no esm support.
## Facts
| | |
|---|---|
| Version | 1.0.16 |
| Published | 2026-08-03 |
| First published | 2016-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 0 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 41 |
| Author | Kiko Beats |
| Maintainers | kikobeats |
| Keywords | canonical, deterministic, digest, hash, json, keys, serialize, sort, stable, stringify |
## Links
- npm: https://www.npmjs.com/package/json-stringify-deterministic
- Repository: https://github.com/kikobeats/json-stringify-deterministic
- Homepage: https://github.com/Kikobeats/json-stringify-deterministic
- Issues: https://github.com/Kikobeats/json-stringify-deterministic/issues
- npm.io page: https://npm.io/package/json-stringify-deterministic
## Alternatives
- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads
## Recent versions
- 1.0.16 (latest) — 2026-08-03
- 1.0.15 — 2026-07-30
- 1.0.14 — 2026-06-19
- 1.0.13 — 2026-04-14
- 1.0.12 — 2023-10-24
- 1.0.11 — 2023-09-07
- 1.0.10 — 2023-07-20
- 1.0.9 — 2023-07-20
- 1.0.8 — 2022-12-14
- 1.0.7 — 2022-05-17
- 1.0.6 — 2022-04-11
- 1.0.5 — 2022-04-01
- 1.0.4 — 2022-03-02
- 1.0.3 — 2022-02-24
- 1.0.2 — 2021-12-22
- … 2 more at https://npm.io/package/json-stringify-deterministic/versions
## README
# json-stringify-deterministic
[](https://coveralls.io/github/Kikobeats/json-stringify-deterministic)
[](https://www.npmjs.org/package/json-stringify-deterministic)
> Deterministic version of `JSON.stringify()`, so you can get a consistent hash from stringified results.
Similar to [json-stable-stringify](https://github.com/substack/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
```bash
npm install json-stringify-deterministic --save
```
## Usage
```js
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}
```
## 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:
``` js
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:
``` js
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:
```js
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}
```
##### 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:
```js
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
// }
```
##### 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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_native_JSON#The_replacer_parameter).
## Related
- [sort-keys-recursive](https://github.com/Kikobeats/sort-keys-recursive): Sort the keys of an array/object recursively.
## License
MIT © [Kiko Beats](https://github.com/Kikobeats).
---
_Source: https://npm.io/package/json-stringify-deterministic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._