Stringify Object as tree structure
npm install 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 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.
$ npm install --save object-treeify
`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
`
- 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
Type: boolean
Default:
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:
Can be used to overwrite the node rendering logic. Node is rendered if result is not equal undefined.
#### sortFn
Type: function
Default:
Function that defines the key sort order. Defaults to ordering of Object.keys(...), which is typically insertion order.
#### breakCircularWith
Type: string or null
Default:
When string`, circular references are broken with that string, at a minor performance cost.
More examples can be found in the tests.