https://github.com/gobwas/json-honey
Yet another super sweet json stringifier-prettyfier-sortifier-sweetifier
https://github.com/gobwas/json-honey
Last synced: about 1 month ago
JSON representation
Yet another super sweet json stringifier-prettyfier-sortifier-sweetifier
- Host: GitHub
- URL: https://github.com/gobwas/json-honey
- Owner: gobwas
- Created: 2014-12-15T08:55:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-03T14:46:57.000Z (almost 10 years ago)
- Last Synced: 2025-02-25T10:50:25.002Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 164 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [JSON](http://json.org)-HONEY
[](http://badge.fury.io/js/json-honey)
[](https://travis-ci.org/gobwas/json-honey)
> Yet another sweetest json prettifier (the best, of course).
## Whatsup
This is a simple tool, that convert your objects to JSON format, aligning the values and sorting the keys.
`honey` can also be used in [CLI](#cli).
Example:
```js
var honey = require("json-honey");
honey({
aaaa: 1,
a: 2,
b: { b: 2, bb: 3, bbb: [1,2,3,null] },
c: new Object
});
```
Will output:
```
{
"aaaa": 1,
"a": 2,
"b": {
"b": 2,
"bb": 3,
"bbb": [
1,
2,
3,
null
]
},
"c": {}
}
```
## API
#### honey(obj, [options])
##### obj
Type: `*`
Object to be stringified.
##### options
Type: `Object`
Optional options.
##### options.pad
Type: `number`
Default: `2`
##### options.sortBy
Type: `Function|Function[]`
Default: `null`
Function (or list of functions) to be applied at each key-value pair of object. Called with definition object with properties `key`, `value`.
It also have properties `parents` with parent nodes keys list, and `scalar` flag, that shows is it primitive value or not.
##### options.sortScalar
Type: `boolean`
Default: `true`
Indicates to sort or not by type of value in the object - is it scalar (primitive) (`boolean`, `string`, `number`) or not.
##### options.sortType
Type: `boolean`
Default: `false`
Indicates to sort or not by type of value. Type catched by `Object.prototype.toString.call(value)`.
##### options.sortKey
Type: `boolean`
Default: `true`
Indicates to sort or not by key.
##### options.scalar
Type: `boolean`
Default: `false`
Replace circular reference with `options.circularValue` or not. If `false`, error will thrown on found circular.
##### options.circularValue
Type: `string`, `boolean`, `number`, `null`
Default: `[Circular]`
Replacement value for circular references if `options.circular` set to `true`.
## CLI
Honey supports cli usage. Run:
```bash
honey
```
to get usage output.
## Install
Of course, via npm.
For usage inside js:
```bash
npm install json-honey
```
For usage as CLI:
```bash
npm install -g json-honey
```