pastgift / sorted-json-js Goto Github PK

Hi,

As per the issue title the instructions in readme.md and code do not align. Option listed as 'sortBy' in the instructions but reference in code 'sortby'.

Cheers,
Brendt

As long as it does, please say so upfront in its readme, and maybe even suggest to try json.sortify if one needs those options.

Example has wrong require:
var sortedJSON = require('./sorted-json');

it should be require('sorted-json'); since you should have installed it already.

While using this function, I ran into the following error when passing nothing into options

This wasn't happening when I was on node 8 but does now appear on node 10

I think you can change

sortBy: null

to

sortBy: undefinded

in DEFAULT_SORT_OPTIONS to fix this, but figured it would be something you want to be aware of

:-)