traverse-all

traverse-all 👌

methods to traverse every thing!

more language:

zh-CN

Install

npm install traverse-all

Usage

base usage

import module

const Traverse = require("traverse-all");

Traverse.traverse_recursive(nodes, options);

import defined method from module

const { traverse_recursive } = require("traverse-all");

traverse_recursive(nodes, options);

Methods Usage

traverse_recursive(nodes,options)

• nodes：Array root nodes
• options：Object traverse options which includes:
  • predicate：Function required
  • nodeHandle：Function required
  • exclude: Function
  • ignore: Function
• return Promise<any>

predicate(node):{done:Boolean,iterators:Array}

• node：current node
• done：whether current node finish traversing
• iterators：node array to traverse of current node

nodeHandle(node,params,options,result):node

• node：current node
• params：node traverse params
• options：traverse options
• result：result which can be trans to next node
• return：node NOTE：even do nothing,you must return the node，ex：node=>node

params：

• path：Array<node>node path
• isLeaf：Boolean
• isFirst：Booleanis first node of current traverse level
• isLast：Booleanis last node of current traverse level

Author

👤 dzg

• Github: @DZG-MELODY

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 dzg.

This project is ISC licensed.