Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blackflux/object-treeify
Stringify Object as tree structure
https://github.com/blackflux/object-treeify
Last synced: 2 months ago
JSON representation
Stringify Object as tree structure
- Host: GitHub
- URL: https://github.com/blackflux/object-treeify
- Owner: blackflux
- License: mit
- Created: 2019-03-18T01:29:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T12:17:14.000Z (over 1 year ago)
- Last Synced: 2024-04-25T23:21:07.440Z (9 months ago)
- Language: JavaScript
- Size: 3.03 MB
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-javascript - object-treeify
- awesome-javascript - object-treeify
README
# object-treeify
[](https://circleci.com/gh/blackflux/object-treeify)
[](https://www.npmjs.com/package/object-treeify)
[](https://www.npmjs.com/package/object-treeify)
Stringify Object as tree structure
```
{
oranges: {
'mandarin': { ├─ oranges
clementine: null, │ └─ mandarin
tangerine: 'so cheap and juicy!' -=> │ ├─ clementine
} │ └─ tangerine: so cheap and juicy!
}, └─ apples
apples: { ├─ gala
'gala': null, └─ pink lady
'pink lady': null
}
}
```
Project was inspired by [treeify](https://github.com/notatestuser/treeify) and works almost identical. However
the algorithm is much shorter and faster, works without recursion and is very memory efficient. Furthermore
the output can be sorted using a custom comparator function.
## Install
$ npm install --save object-treeify
## Usage
```js
const treeify = require('object-treeify');
treeify({
oranges: {
mandarin: {
clementine: null,
tangerine: 'so cheap and juicy!'
}
},
apples: {
gala: null,
'pink lady': null
}
}, {/* options */});
// =>
// ├─ oranges
// │ └─ mandarin
// │ ├─ clementine
// │ └─ tangerine: so cheap and juicy!
// └─ apples
// ├─ gala
// └─ pink lady
```
### Features
- Allows for custom sorting
- Very fast and memory efficient implementation
- Input traversed exactly once
- Dependency free and small in size
- Tests to verify correctness
- Handles circular references
## Options
### joined
Type: `boolean`
Default: `true`
By default a single string is returned. Can be set to `false` to instead return an array containing lines.
#### spacerNoNeighbour
Type: `string`
Default: ` `
Prefix for depth level when no further neighbour is present.
#### spacerNeighbour
Type: `string`
Default: `│ `
Prefix for depth level when a further neighbour is present.
#### keyNoNeighbour
Type: `string`
Default: `└─ `
Prefix for key when no further neighbour is present.
#### keyNeighbour
Type: `string`
Default: `├─ `
Prefix for key when a further neighbour is present.
#### separator
Type: `string`
Default: `: `
Used to separate node key from node value.
#### renderFn
Type: `function`
Default: `(node) => (['boolean', 'string', 'number'].includes(typeof node) ? node : undefined)`
Can be used to overwrite the node rendering logic. Node is rendered if result is not equal `undefined`.
#### sortFn
Type: `function`
Default: `null`
Function that defines the key sort order. Defaults to ordering of `Object.keys(...)`, which is typically insertion order.
#### breakCircularWith
Type: `string` or `null`
Default: ` (circular ref.)`
When `string`, circular references are broken with that string, at a minor performance cost.
## Examples
More examples can be found in the tests.