Skip to content

Commit

Permalink
Format README of @solana/fast-stable-stringify (#2503)
Browse files Browse the repository at this point in the history
  • Loading branch information
steveluscher authored Apr 17, 2024
1 parent 5ed19c6 commit e4475ef
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions packages/fast-stable-stringify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,24 @@ The most popular repository providing this feature is [substack's json-stable-st
Usage:

```javascript
var stringify = require('fast-stable-stringify');
import stringify from '@solana/fast-stable-stringify';
stringify({ d: 0, c: 1, a: 2, b: 3, e: 4 }); // '{"a":2,"b":3,"c":1,"d":0,"e":4}'
```

Just like substack's, it does:

* handle all variations of all basic javascript values (number, string, boolean, array, object, null, Date, BigInt)
* handle undefined _and_ function in the same way as `JSON.stringify`
* **not support ie8 (and below) with complete certainty**.
- handle all variations of all basic javascript values (number, string, boolean, array, object, null, Date, BigInt)
- handle undefined _and_ function in the same way as `JSON.stringify`
- **not support ie8 (and below) with complete certainty**.

Unlike substack's, it does:

* not implement the 'replacer' or 'space' arguments of the JSON.stringify method
* not check for circular references

- not implement the 'replacer' or 'space' arguments of the JSON.stringify method
- not check for circular references

## Running tests

```
npm run test:unit:browser
npm run test:unit:node
```
npm run test:unit:node
```

0 comments on commit e4475ef

Please sign in to comment.