https://github.com/streamich/tree-dump
Simple console tree printing helpers
https://github.com/streamich/tree-dump
Last synced: 11 months ago
JSON representation
Simple console tree printing helpers
- Host: GitHub
- URL: https://github.com/streamich/tree-dump
- Owner: streamich
- License: apache-2.0
- Created: 2024-05-01T06:29:09.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-07-22T11:33:58.000Z (11 months ago)
- Last Synced: 2025-08-09T17:54:18.627Z (11 months ago)
- Language: TypeScript
- Size: 364 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# `tree-dump`
Prints a tree structure to the console. Can print a binary tree or a tree with any number of children.
## Usage
Install
```
npm install tree-dump
```
Print a non-binary tree
```js
import {printTree} from 'tree-dump';
const str = 'start' + printTree('', [
(tab) => 'line 1',
() => '',
(tab) => 'line 2' + printTree(tab, [
(tab) => 'line 2.1',
(tab) => 'line 2.2',
])
(tab) => 'line 3',
]);
console.log(str);
// start
// ├── line 1
// │
// ├── line 2
// │ ├── line 2.1
// │ └── line 2.2
// └── line 3
```
Print a binary tree
```js
import {printBinary} from 'tree-dump';
const str =
'Node' +
printBinary('', [
(tab) => 'left' + printBinary(tab, [
() => 'left 1',
() => 'right 1',
]),
(tab) => 'right' + printBinary(tab, [
() => 'left 2',
() => 'right 2',
]),
]);
console.log(str);
// Node
// ← left
// ← left 1
// → right 1
// → right
// ← left 2
// → right 2
```