# kvgraph

> graph with links and reducing

Latest version **0.1.0** (published 2016-09-27) · Fair license · 0 weekly downloads

## Install

```sh
npm install kvgraph
pnpm add kvgraph
yarn add kvgraph
bun add kvgraph
```

## 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.1.0 |
| Published | 2016-09-27 |
| First published | 2016-09-27 |
| Weekly downloads | 0 |
| License | Fair |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Charles Lehner |
| Maintainers | cel |

## Links

- npm: https://www.npmjs.com/package/kvgraph
- npm.io page: https://npm.io/package/kvgraph

## Recent versions

- 0.1.0 (latest) — 2016-09-27

## README

# kvgraph

A graph that you can add elements to with key and value. Edges are detected
via links in values to other keys.  You can perform computation on the graph using reduce functions.

```js
var KVGraph = require('kvgraph')

var graph = new KVGraph()
```

### graph.add(key, value)

Add an item to the graph. The graph is considered immutable, so a value can
only be set once for a key. `key` should be a string. `value` may be any type.
Any property of `value` will be indexed as potentially a link to another value.

### graph.reduce(fn) : value

- fn(states, object) : state

Compute a reduce on the elements in the graph, in no particular order. Use if
your function is commutative.

`fn` gets called for each object in the graph. `states` is an array of
previously reduced values that the current object links to (or is linked to by,
in the case of `reduceRight`). The return value of `fn`
goes into `states` for the next objects. `object` will be `undefined` when
computing the final reduce value.

### graph.reduceLeft(fn) : value

Compute a reduce on the elements in the graph. It is a left reduce so you can
use it with a left-associative function.

### graph.reduceRight(fn) : value

Same as `reduceLeft`, except it is a right-reduce so `fn` should be a
right-associative function.

### graph.getRoots() : object

Get the roots of the graph - elements that don't link to any other elements.
Returns an object where the keys are object keys.

### graph.getHeads() : object

Get the heads of the graph - elements that are not linked to by other elements.
Returns an object where the keys are object keys.

## License

Copyright (c) 2016 Charles Lehner

Usage of the works is permitted provided that this instrument is
retained with the works, so that any entity that uses the works is
notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.

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