Skip to content

Commit

Permalink
Merge pull request #11 from sxwei123/develop
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
sxwei123 committed Mar 5, 2021
2 parents 8756e5b + c9cb83b commit bbe14ff
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

![Test status](https://github.com/sxwei123/quick-stable-stringify/workflows/Lint%20and%20Test/badge.svg?branch=master)

Deterministic `JSON.stringify()` - a faster version of [@epoberezkin](https://github.com/epoberezkin)'s [fast-json-stable-strigify](https://github.com/epoberezkin/fast-json-stable-stringify). Built with Typescript and modern Javascript.
Deterministic `JSON.stringify()`. Sort Javascript object in alphabetical order or the comparator function you specify.

A faster version of [@epoberezkin](https://github.com/epoberezkin)'s [fast-json-stable-stringify](https://github.com/epoberezkin/fast-json-stable-stringify). Built with Typescript and modern Javascript.

## Compatibility

Expand Down Expand Up @@ -46,7 +48,7 @@ Options can be a comparator function or an object which has two optional propert

### cmp

`opts.cmp` is the custom comparator function that user can specify. If custom comparator function is not provided, the JSON string of an object will be sorted by the alphanumeric order of object keys.
`opts.cmp` is the custom comparator function that user can specify. If custom comparator function is not provided, the JSON string of an object will be sorted by the alphabetical order of object keys.
The type of the comparator function is defined as:

```ts
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "quick-stable-stringify",
"version": "0.1.6",
"version": "0.1.7",
"description": "Deterministic `JSON.stringify()` - a faster version of Evgeny's fast-json-stable-strigify. Built with Typescript and modern Javascript.",
"main": "./dist/index.js",
"exports": "./dist/index.js",
Expand Down

0 comments on commit bbe14ff

Please sign in to comment.