https://github.com/ngryman/tree-mutate

:leaves: n-ary tree mutation library.
https://github.com/ngryman/tree-mutate

Last synced: about 2 months ago
JSON representation

:leaves: n-ary tree mutation library.

• Host: GitHub
• URL: https://github.com/ngryman/tree-mutate
• Owner: ngryman
• License: mit
• Created: 2016-09-06T23:38:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-04T11:09:12.000Z (over 6 years ago)
• Last Synced: 2024-07-26T17:55:50.724Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 38.1 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# tree-mutate

> n-ary tree mutation library.

[![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url]

[travis-image]: https://img.shields.io/travis/ngryman/tree-mutate.svg?style=flat

[travis-url]: https://travis-ci.org/ngryman/tree-mutate

[codecov-image]: https://img.shields.io/codecov/c/github/ngryman/tree-mutate.svg

[codecov-url]: https://codecov.io/github/ngryman/tree-mutate

**tree-mutate** lets you mutate `n-ary` trees at both structural level and node level. You can apply both **homomorphisms** or **isomorphisms**. You can mutate node labels (value).

In other words, `tree-mutate` lets you easily create high-order functions such as **map** or **filter** that work well with your specific tree structure.

`tree-mutate` works around **mutators**. Those mutators define logic to handle tree mutations. Depending on your needs and your tree structure, you can implement mutators to do whatever you want.

## Install

```bash

npm install --save tree-mutate

```

## Usage

```javascript

import mutate from 'tree-mutate'

// add a `depth` property to each node

tree = mutate(tree, (node, context) => { node.depth = context.depth })

// only keep `type` property

tree = mutate(tree, node => pick(node, 'type'))

// filter nodes with type=foo

tree = mutate(tree, node => ('foo' === node.type ? node : null), remover)

```

See [more examples](test/examples.js).

## API

See the [api](docs/api.md) documentation.

## Related

 - [tree-morph](https://github.com/ngryman/tree-morph) Little brother of `tree-mutate`, but for **immutable** trees.

 - [tree-crawl](https://github.com/ngryman/tree-crawl) n-ary tree traversal library. This module uses it.

## License

MIT © [Nicolas Gryman](http://ngryman.sh)