# @drodsou/tree2text

> Converts object tree to text

Latest version **0.3.0** (published 2020-01-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @drodsou/tree2text
pnpm add @drodsou/tree2text
yarn add @drodsou/tree2text
bun add @drodsou/tree2text
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2020-01-06 |
| First published | 2020-01-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | @drodsou |
| Maintainers | drodsou |
| Keywords | object, tree, text, menu, table of contents, javascript |

## Links

- npm: https://www.npmjs.com/package/@drodsou/tree2text
- Repository: https://github.com/drodsou/tree2text
- Homepage: https://github.com/drodsou/tree2text#readme
- Issues: https://github.com/drodsou/tree2text/issues
- npm.io page: https://npm.io/package/@drodsou/tree2text

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2020-01-06
- 0.2.5 — 2020-01-05
- 0.2.4 — 2020-01-05
- 0.1.0 — 2020-01-05

## README

# @drodsou/tree2text

Converts object tree to text

# installation

```
npm install @drodsou/tree2text
```

# usage
```js
const tree2text = require('@drodsou/tree2text');

let treeAsString = tree2text(myTree, myRender);
```

# api

for structure of `myTree` and `myRender` parameters see `index.js` JSDoc comments of the funcion and the test examples in `/test`

# examples 

see /tests folder for examples of conversion to ToC, HTML, React

# built-in HTML render

Note that the HTML render is included by default in /lib, you can use it just specifying passing the string `html` instead of the `myRender` object

---
_Source: https://npm.io/package/@drodsou/tree2text · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._