npmpackage.info

json-stringify-deterministic

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

1.0.12

MIT

JavaScript

769.00 B

9,542,290 5.1

Installations

npm install json-stringify-deterministic

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>= 4

Node Version

18.18.2

NPM Version

9.8.1 Score

99.5

Supply Chain

100

Quality

75.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

18

Closed

4

Merged

14

Issues

Open

0

Total

3

Closed

3

Releases

v1.0.12

Published on 24 Oct 2023

v1.0.11

Published on 07 Sept 2023

v1.0.10

Published on 20 Jul 2023

v1.0.9

Published on 20 Jul 2023

v1.0.8

Published on 14 Dec 2022

v1.0.7

Published on 17 May 2022

View all 11 releases

Contributors

Unable to fetch Contributors

View all 6 contributors

Languages

JavaScript

JavaScript (100%)

Developer

kikobeats

Download Statistics

Total Downloads

9,542,290

Last Day

18,553

Last Week

75,906

Last Month

347,196

Last Year

3,545,350

GitHub Statistics

37 Stars

73 Commits

8 Forks

3 Watching

1 Branches

6 Contributors

Bundle Size

1.49 kB

Minified

769.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.12

Package Id

json-stringify-deterministic@1.0.12

Unpacked Size

11.36 kB

Size

4.45 kB

File Count

NPM Version

9.8.1

Node Version

18.18.2

Publised On

24 Oct 2023

Total Downloads

Cumulative downloads

Total Downloads

9,542,290

Last day

0.2%

18,553

Compared to previous day

Last week

-18.1%

75,906

Compared to previous week

Last month

1.4%

347,196

Compared to previous month

Last year

60%

3,545,350

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@commitlint/cli @commitlint/config-conventional @ksmithut/prettier-standard c8 ci-publish conventional-github-releaser finepack git-authors-cli mocha nano-staged npm-check-updates should simple-git-hooks standard standard-markdown standard-version

Versions

json-stringify-deterministic

Last version

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.

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

License

No vulnerabilities found.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

7

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

5

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.1

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to json-stringify-deterministic

fast-json-stable-stringify

2.1.0

deterministic `JSON.stringify()` - a faster version of substack's json-stable-strigify without jsonify

json-stable-stringify-without-jsonify

1.0.1

deterministic JSON.stringify() with custom sorting to get deterministic hashes from stringified results, with no public domain dependencies

json-stable-stringify

1.2.1

deterministic JSON.stringify() with custom sorting to get deterministic hashes from stringified results

safe-stable-stringify

2.5.0

Deterministic and safely JSON.stringify to quickly serialize JavaScript objects

json-stringify-deterministic

Installations

Developer Guide

Yes

CommonJS

>= 4

18.18.2

9.8.1

Score

Pull Requests

0

18

4

14

Issues

0

3

3

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

kikobeats

Download Statistics

GitHub Statistics

Bundle Size

1.49 kB

769.00 B

Maintainers

Package Meta Information

Total Downloads

9,542,290

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

json-stringify-deterministic

Install

Usage

API

stringify(<obj>, [opts])

obj

opts

opts.stringify

opts.cycles

opts.compare

opts.space

opts.replacer

Related

License

10

10

10

10

10

7

5

0

0

0

0

0

0

5.1

/10

Other packages similar to json-stringify-deterministic