@klippersubs/bfs

![Travis CI][ci]
![NPM version][npm]

> General purpose BFS implementation.

```bash
yarn add @klippersubs/bfs
``

``javascript
import { flatten } from '@klippersubs/bfs';

const en = { name: 'en', fallback: [] };
const ru = { name: 'ru', fallback: [en] };
const be = { name: 'be', fallback: [ru] };
const uk = { name: 'uk', fallback: [be, ru] };

be.fallback = [ru, uk];

const beTarask = { name: 'be-tarask', fallback: [be, uk] };

const lookupList = flatten(null, beTarask, (_, language) => language.fallback);

console.log(lookupList);
// → Set {
// { name: 'be-tarask', fallback: [ [Object], [Object] ] },
// { name: 'be', fallback: [ [Object], [Object] ] },
// { name: 'uk', fallback: [ [Object], [Object] ] },
// { name: 'ru', fallback: [ [Object] ] },
// { name: 'en', fallback: [] } }
``

Exported API

$3

> Returns children of the given vertex in the given graph.

Generic params:

* Graph — graph type.
* Vertex — vertex type.

Params:

* graph: Graph — graph containing the vertex.
* vertex: Vertex — vertex in the graph.

Return value:

* Array — flat array of vertices.

$3

> Flattens cyclic graph starting from root vertex.

Generic params:

* Graph — graph type.
* Vertex — vertex type.

Params:

* graph: Graph — graph or forest.
* root: Vertex — vertex to start search.
* getChildren: ChildrenGetter — returns children
of the given vertex.

Return value:

* Set` — flat set of vertices.

License

MIT

[ci]: https://travis-ci.org/klippersubs/bfs
[npm]: https://www.npmjs.com/package/@klippersubs/bfs