package/package.json000644 000770 000024 0000002271 13173675444013031 0ustar00000000 000000 { "name": "fast-json-stable-stringify", "version": "2.0.0", "description": "deterministic `JSON.stringify()` - a faster version of substack's json-stable-strigify without jsonify", "main": "index.js", "devDependencies": { "benchmark": "^2.1.4", "coveralls": "^3.0.0", "eslint": "^4.9.0", "fast-stable-stringify": "latest", "faster-stable-stringify": "latest", "json-stable-stringify": "latest", "nyc": "^11.2.1", "pre-commit": "^1.2.2", "tape": "~1.0.4" }, "scripts": { "eslint": "eslint index.js test", "test-spec": "tape test/*.js", "test": "npm run eslint && nyc npm run test-spec" }, "repository": { "type": "git", "url": "git://github.com/epoberezkin/fast-json-stable-stringify.git" }, "homepage": "https://github.com/epoberezkin/fast-json-stable-stringify", "keywords": [ "json", "stringify", "deterministic", "hash", "stable" ], "author": { "name": "James Halliday", "email": "mail@substack.net", "url": "http://substack.net" }, "license": "MIT", "nyc": { "exclude": [ "test", "node_modules" ], "reporter": [ "lcov", "text-summary" ] } } package/.npmignore000644 000770 000024 0000000056 13173673754012543 0ustar00000000 000000 node_modules .nyc_output/ coverage/ .DS_Store package/README.md000644 000770 000024 0000005446 13173675343012027 0ustar00000000 000000 # fast-json-stable-stringify Deterministic `JSON.stringify()` - a faster version of [@substack](https://github.com/substack)'s json-stable-strigify without [jsonify](https://github.com/substack/jsonify). You can also pass in a custom comparison function. [![Build Status](https://travis-ci.org/epoberezkin/fast-json-stable-stringify.svg?branch=master)](https://travis-ci.org/epoberezkin/fast-json-stable-stringify) [![Coverage Status](https://coveralls.io/repos/github/epoberezkin/fast-json-stable-stringify/badge.svg?branch=master)](https://coveralls.io/github/epoberezkin/fast-json-stable-stringify?branch=master) # example ``` js var stringify = require('fast-json-stable-stringify'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; console.log(stringify(obj)); ``` output: ``` {"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8} ``` # methods ``` js var stringify = require('fast-json-stable-stringify') ``` ## var str = stringify(obj, opts) Return a deterministic stringified string `str` from the object `obj`. ## options ### cmp If `opts` is given, you can supply an `opts.cmp` to have a custom comparison function for object keys. Your function `opts.cmp` 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 var stringify = require('fast-json-stable-stringify'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; var s = stringify(obj, function (a, b) { return a.key < b.key ? 1 : -1; }); console.log(s); ``` which results in the output string: ``` {"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: ``` var stringify = require('fast-json-stable-stringify'); var obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 }; var s = stringify(obj, function (a, b) { return a.value < b.value ? 1 : -1; }); console.log(s); ``` which outputs: ``` {"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10} ``` ### cycles Pass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the result will not be a valid JSON string in this case. TypeError will be thrown in case of circular object without this option. # install With [npm](https://npmjs.org) do: ``` npm install fast-json-stable-stringify ``` # benchmark To run benchmark (requires Node.js 6+): ``` node benchmark ``` Results: ``` fast-json-stable-stringify x 17,189 ops/sec ±1.43% (83 runs sampled) json-stable-stringify x 13,634 ops/sec ±1.39% (85 runs sampled) fast-stable-stringify x 20,212 ops/sec ±1.20% (84 runs sampled) faster-stable-stringify x 15,549 ops/sec ±1.12% (84 runs sampled) The fastest is fast-stable-stringify ``` # license [MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE) package/LICENSE000644 000770 000024 0000002061 13173601746011537 0ustar00000000 000000 This software is released under the MIT license: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. package/index.js000644 000770 000024 0000003465 13173673457012220 0ustar00000000 000000 'use strict'; module.exports = function (data, opts) { if (!opts) opts = {}; if (typeof opts === 'function') opts = { cmp: opts }; var cycles = (typeof opts.cycles === 'boolean') ? opts.cycles : false; var cmp = opts.cmp && (function (f) { return function (node) { return function (a, b) { var aobj = { key: a, value: node[a] }; var bobj = { key: b, value: node[b] }; return f(aobj, bobj); }; }; })(opts.cmp); var seen = []; return (function stringify (node) { if (node && node.toJSON && typeof node.toJSON === 'function') { node = node.toJSON(); } if (node === undefined) return; if (typeof node == 'number') return isFinite(node) ? '' + node : 'null'; if (typeof node !== 'object') return JSON.stringify(node); var i, out; if (Array.isArray(node)) { out = '['; for (i = 0; i < node.length; i++) { if (i) out += ','; out += stringify(node[i]) || 'null'; } return out + ']'; } if (node === null) return 'null'; if (seen.indexOf(node) !== -1) { if (cycles) return JSON.stringify('__cycle__'); throw new TypeError('Converting circular structure to JSON'); } var seenIndex = seen.push(node) - 1; var keys = Object.keys(node).sort(cmp && cmp(node)); out = ''; for (i = 0; i < keys.length; i++) { var key = keys[i]; var value = stringify(node[key]); if (!value) continue; if (out) out += ','; out += JSON.stringify(key) + ':' + value; } seen.splice(seenIndex, 1); return '{' + out + '}'; })(data); }; package/.travis.yml000644 000770 000024 0000000154 13173611445012641 0ustar00000000 000000 language: node_js node_js: - "4" - "6" - "7" - "8" after_script: - coveralls < coverage/lcov.info package/.eslintrc.yml000644 000770 000024 0000001062 13173613422013150 0ustar00000000 000000 extends: eslint:recommended env: node: true browser: true rules: block-scoped-var: 2 callback-return: 2 dot-notation: 2 indent: 2 linebreak-style: [2, unix] new-cap: 2 no-console: [2, allow: [warn, error]] no-else-return: 2 no-eq-null: 2 no-fallthrough: 2 no-invalid-this: 2 no-return-assign: 2 no-shadow: 1 no-trailing-spaces: 2 no-use-before-define: [2, nofunc] quotes: [2, single, avoid-escape] semi: [2, always] strict: [2, global] valid-jsdoc: [2, requireReturn: false] no-control-regex: 0 no-useless-escape: 2 package/benchmark/index.js000644 000770 000024 0000001344 13173660776014144 0ustar00000000 000000 'use strict'; const Benchmark = require('benchmark'); const suite = new Benchmark.Suite; const testData = require('./test.json'); const stringifyPackages = { // 'JSON.stringify': JSON.stringify, 'fast-json-stable-stringify': require('../index'), 'json-stable-stringify': true, 'fast-stable-stringify': true, 'faster-stable-stringify': true }; for (const name in stringifyPackages) { let func = stringifyPackages[name]; if (func === true) func = require(name); suite.add(name, function() { func(testData); }); } suite .on('cycle', (event) => console.log(String(event.target))) .on('complete', function () { console.log('The fastest is ' + this.filter('fastest').map('name')); }) .run({async: true}); package/benchmark/test.json000644 000770 000024 0000007364 13173662463014354 0ustar00000000 000000 [ { "_id": "59ef4a83ee8364808d761beb", "index": 0, "guid": "e50ffae9-7128-4148-9ee5-40c3fc523c5d", "isActive": false, "balance": "$2,341.81", "picture": "http://placehold.it/32x32", "age": 28, "eyeColor": "brown", "name": "Carey Savage", "gender": "female", "company": "VERAQ", "email": "careysavage@veraq.com", "phone": "+1 (897) 574-3014", "address": "458 Willow Street, Henrietta, California, 7234", "about": "Nisi reprehenderit nulla ad officia pariatur non dolore laboris irure cupidatat laborum. Minim eu ex Lorem adipisicing exercitation irure minim sunt est enim mollit incididunt voluptate nulla. Ut mollit anim reprehenderit et aliqua ex esse aliquip. Aute sit duis deserunt do incididunt consequat minim qui dolor commodo deserunt et voluptate.\r\n", "registered": "2014-05-21T01:56:51 -01:00", "latitude": 63.89502, "longitude": 62.369807, "tags": [ "nostrud", "nisi", "consectetur", "ullamco", "cupidatat", "culpa", "commodo" ], "friends": [ { "id": 0, "name": "Henry Walls" }, { "id": 1, "name": "Janice Baker" }, { "id": 2, "name": "Russell Bush" } ], "greeting": "Hello, Carey Savage! You have 4 unread messages.", "favoriteFruit": "banana" }, { "_id": "59ef4a83ff5774a691454e89", "index": 1, "guid": "2bee9efc-4095-4c2e-87ef-d08c8054c89d", "isActive": true, "balance": "$1,618.15", "picture": "http://placehold.it/32x32", "age": 35, "eyeColor": "blue", "name": "Elinor Pearson", "gender": "female", "company": "FLEXIGEN", "email": "elinorpearson@flexigen.com", "phone": "+1 (923) 548-3751", "address": "600 Bayview Avenue, Draper, Montana, 3088", "about": "Mollit commodo ea sit Lorem velit. Irure anim esse Lorem sint quis officia ut. Aliqua nisi dolore in aute deserunt mollit ex ea in mollit.\r\n", "registered": "2017-04-22T07:58:41 -01:00", "latitude": -87.824919, "longitude": 69.538927, "tags": [ "fugiat", "labore", "proident", "quis", "eiusmod", "qui", "est" ], "friends": [ { "id": 0, "name": "Massey Wagner" }, { "id": 1, "name": "Marcella Ferrell" }, { "id": 2, "name": "Evans Mckee" } ], "greeting": "Hello, Elinor Pearson! You have 3 unread messages.", "favoriteFruit": "strawberry" }, { "_id": "59ef4a839ec8a4be4430b36b", "index": 2, "guid": "ddd6e8c0-95bd-416d-8b46-a768d6363809", "isActive": false, "balance": "$2,046.95", "picture": "http://placehold.it/32x32", "age": 40, "eyeColor": "green", "name": "Irwin Davidson", "gender": "male", "company": "DANJA", "email": "irwindavidson@danja.com", "phone": "+1 (883) 537-2041", "address": "439 Cook Street, Chapin, Kentucky, 7398", "about": "Irure velit non commodo aliqua exercitation ut nostrud minim magna. Dolor ad ad ut irure eu. Non pariatur dolor eiusmod ipsum do et exercitation cillum. Et amet laboris minim eiusmod ullamco magna ea reprehenderit proident sunt.\r\n", "registered": "2016-09-01T07:49:08 -01:00", "latitude": -49.803812, "longitude": 104.93279, "tags": [ "consequat", "enim", "quis", "magna", "est", "culpa", "tempor" ], "friends": [ { "id": 0, "name": "Ruth Hansen" }, { "id": 1, "name": "Kathrine Austin" }, { "id": 2, "name": "Rivera Munoz" } ], "greeting": "Hello, Irwin Davidson! You have 2 unread messages.", "favoriteFruit": "banana" } ] package/example/key_cmp.js000644 000770 000024 0000000261 13173601746014152 0ustar00000000 000000 var stringify = require('../'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; var s = stringify(obj, function (a, b) { return a.key < b.key ? 1 : -1; }); console.log(s); package/example/nested.js000644 000770 000024 0000000155 13173601746014007 0ustar00000000 000000 var stringify = require('../'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; console.log(stringify(obj)); package/example/str.js000644 000770 000024 0000000141 13173601746013330 0ustar00000000 000000 var stringify = require('../'); var obj = { c: 6, b: [4,5], a: 3 }; console.log(stringify(obj)); package/example/value_cmp.js000644 000770 000024 0000000274 13173601746014502 0ustar00000000 000000 var stringify = require('../'); var obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 }; var s = stringify(obj, function (a, b) { return a.value < b.value ? 1 : -1; }); console.log(s); package/test/cmp.js000644 000770 000024 0000000536 13173614416012631 0ustar00000000 000000 'use strict'; var test = require('tape'); var stringify = require('../'); test('custom comparison function', function (t) { t.plan(1); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; var s = stringify(obj, function (a, b) { return a.key < b.key ? 1 : -1; }); t.equal(s, '{"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3}'); }); package/test/nested.js000644 000770 000024 0000002173 13173614366013337 0ustar00000000 000000 'use strict'; var test = require('tape'); var stringify = require('../'); test('nested', function (t) { t.plan(1); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; t.equal(stringify(obj), '{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}'); }); test('cyclic (default)', function (t) { t.plan(1); var one = { a: 1 }; var two = { a: 2, one: one }; one.two = two; try { stringify(one); } catch (ex) { t.equal(ex.toString(), 'TypeError: Converting circular structure to JSON'); } }); test('cyclic (specifically allowed)', function (t) { t.plan(1); var one = { a: 1 }; var two = { a: 2, one: one }; one.two = two; t.equal(stringify(one, {cycles:true}), '{"a":1,"two":{"a":2,"one":"__cycle__"}}'); }); test('repeated non-cyclic value', function(t) { t.plan(1); var one = { x: 1 }; var two = { a: one, b: one }; t.equal(stringify(two), '{"a":{"x":1},"b":{"x":1}}'); }); test('acyclic but with reused obj-property pointers', function (t) { t.plan(1); var x = { a: 1 }; var y = { b: x, c: x }; t.equal(stringify(y), '{"b":{"a":1},"c":{"a":1}}'); }); package/test/str.js000644 000770 000024 0000002146 13173673732012667 0ustar00000000 000000 'use strict'; var test = require('tape'); var stringify = require('../'); test('simple object', function (t) { t.plan(1); var obj = { c: 6, b: [4,5], a: 3, z: null }; t.equal(stringify(obj), '{"a":3,"b":[4,5],"c":6,"z":null}'); }); test('object with undefined', function (t) { t.plan(1); var obj = { a: 3, z: undefined }; t.equal(stringify(obj), '{"a":3}'); }); test('object with null', function (t) { t.plan(1); var obj = { a: 3, z: null }; t.equal(stringify(obj), '{"a":3,"z":null}'); }); test('object with NaN and Infinity', function (t) { t.plan(1); var obj = { a: 3, b: NaN, c: Infinity }; t.equal(stringify(obj), '{"a":3,"b":null,"c":null}'); }); test('array with undefined', function (t) { t.plan(1); var obj = [4, undefined, 6]; t.equal(stringify(obj), '[4,null,6]'); }); test('object with empty string', function (t) { t.plan(1); var obj = { a: 3, z: '' }; t.equal(stringify(obj), '{"a":3,"z":""}'); }); test('array with empty string', function (t) { t.plan(1); var obj = [4, '', 6]; t.equal(stringify(obj), '[4,"",6]'); }); package/test/to-json.js000644 000770 000024 0000001137 13173614306013437 0ustar00000000 000000 'use strict'; var test = require('tape'); var stringify = require('../'); test('toJSON function', function (t) { t.plan(1); var obj = { one: 1, two: 2, toJSON: function() { return { one: 1 }; } }; t.equal(stringify(obj), '{"one":1}' ); }); test('toJSON returns string', function (t) { t.plan(1); var obj = { one: 1, two: 2, toJSON: function() { return 'one'; } }; t.equal(stringify(obj), '"one"'); }); test('toJSON returns array', function (t) { t.plan(1); var obj = { one: 1, two: 2, toJSON: function() { return ['one']; } }; t.equal(stringify(obj), '["one"]'); });