https://github.com/rumkin/normjson
Convert object into JSON string according to schema
https://github.com/rumkin/normjson
Last synced: 9 months ago
JSON representation
Convert object into JSON string according to schema
- Host: GitHub
- URL: https://github.com/rumkin/normjson
- Owner: rumkin
- License: other
- Created: 2016-11-26T11:32:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:34:48.000Z (over 3 years ago)
- Last Synced: 2025-03-04T02:51:21.938Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 722 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# NormJSON
Convert JS values into deterministic JSON. It can sort keys in ascending
order or according to scheme. Normjson is useful for hash algorithms to generate the same hashsum in different js environments.
## Installation
Install via npm
```bash
npm i normjson
```
Require from unpkg.com:
```html
```
## Example
Normjson will create the same JSON string from objects with different props order and `JSON.stringify` does not:
```javascript
const object1 = {a: 1, b: 2};
const object2 = {b: 2, a: 1};
JSON.stringify(object1) === JSON.stringify(object2); // => false
normjson(object1) === normjson(object2); // => true
```
## Scheme types
### No scheme
If no scheme specified then properties sorting by name in ascending order:
```javascript
normjson({c: 3, a:1, b:2});
```
Coverts to:
```json
{"a":1,"b":2,"c":3}
```
Scheme could be presented in several ways.
### Array scheme
Array scheme contains list of properties which should be converted in specified
order.
```javascript
normjson({a:1, b:2, c: 3}, ['b', 'a']);
```
Convets to:
```json
{"b":2,"a":1}
```
It allow to specify *rest of props* with true and sorts them by key names:
```javascript
normjson({b: 3, c: 2, a: 1}, ['c', true]);
```
Coverts to:
```json
{"c":3,"a":1,"b":2}
```
Rest of props could be set as the first, the last or in the middle.
### Object scheme
Object scheme allow nesting.
```javascript
normjson({a:{b: 1, c:2}}, {a:{c: true}});
```
Coverts to:
```json
{"a":{"c":2}}
```
### Function scheme
Function as a scheme should return other type of scheme (array, object, no).
The first argument is a document.
## License
MIT.