https://github.com/nervgh/recursive-iterator

It iterates through a graph recursively
https://github.com/nervgh/recursive-iterator

recursion recursive-iterator traversal

Last synced: 1 day ago
JSON representation

It iterates through a graph recursively

• Host: GitHub
• URL: https://github.com/nervgh/recursive-iterator
• Owner: nervgh
• License: mit
• Created: 2015-03-01T15:21:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-10T19:31:29.000Z (over 7 years ago)
• Last Synced: 2024-05-23T01:07:52.071Z (6 months ago)
• Topics: recursion, recursive-iterator, traversal
• Language: JavaScript
• Homepage:
• Size: 114 KB
• Stars: 90
• Watchers: 4
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Recursive Iterator

[![NPM version][npm-image]][npm-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

## About

It iterates through a graph or a tree recursively.

## Versions

+ for support ES5 see `2.x.x` versions

## Getting started

### Quick overview (es6)

```js

let iterator = new RecursiveIterator(

  root /* {Object|Array} */,

  [bypassMode = 0] /* {Number} */,

  [ignoreCircular = false] /* {Boolean} */,

  [maxDeep = 100] /* {Number} */

)

let {value, done} = iterator.next()

let {parent, node, key, path, deep} = value

// parent is parent node

// node is current node

// key is key of node

// path is path to node

// deep is current deep

```

### Example (es6)

```js

let root = {

  object: {

    number: 1

  },

  string: 'foo'

}

for (let {node, path} of new RecursiveIterator(root)) {

  console.log(path.join('.'), node)

}

// object    Object {number: 1}

// object.number    1

// string    foo

```

## Roadmap

* [Syntax](https://github.com/nervgh/recursive-iterator/wiki/Syntax)

    * [ES6](https://github.com/nervgh/recursive-iterator/wiki/Syntax#es6)

    * [ES5](https://github.com/nervgh/recursive-iterator/wiki/Syntax#es5)

* API

    * [Options](https://github.com/nervgh/recursive-iterator/wiki/Options)

    * [Methods & Callbacks](https://github.com/nervgh/recursive-iterator/wiki/Methods-&-Callbacks)

* [Cookbook (es6)](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6))

    * [Iterator (not recursive)](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#iterator-not-recursive)

    * [DomIterator](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#domiterator)

    * [Deep copy / Deep clone](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#deep-copy--deep-clone)

    * [To Query String](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#to-query-string)

    * [To Form Data](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#to-form-data)

    * [Uninformed search algorithms](https://github.com/nervgh/recursive-iterator/wiki/Cookbook-(es6)#uninformed-search-algorithms)

## Package managers

### Bower

```

bower install recursive-iterator

```

You could find this module in bower like [_recursive iterator_](http://bower.io/search/?q=recursive%20iterator).

### NPM

```

npm install recursive-iterator

```

You could find this module in npm like [_recursive iterator_](https://www.npmjs.com/search?q=recursive+iterator).

[npm-image]: https://img.shields.io/npm/v/recursive-iterator.svg?style=flat

[npm-url]: https://npmjs.org/package/recursive-iterator

[travis-image]: https://img.shields.io/travis/nervgh/recursive-iterator.svg?style=flat

[travis-url]: https://travis-ci.org/nervgh/recursive-iterator

[coveralls-image]: https://img.shields.io/coveralls/nervgh/recursive-iterator.svg?style=flat

[coveralls-url]: https://coveralls.io/r/nervgh/recursive-iterator?branch=master