# tolstoy

> Generic graph structure with ascetic API

Latest version **1.2.4** (published 2015-10-21) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2015-10-21 |
| First published | 2015-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Deema Yvanow |
| Maintainers | dfcreative |
| Keywords | graph, structure, math |

## Links

- npm: https://www.npmjs.com/package/tolstoy
- Repository: https://github.com/dfcreative/tolstoy
- Issues: https://github.com/dfcreative/tolstoy/issues
- npm.io page: https://npm.io/package/tolstoy

## Dependencies (2)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [inherits](https://npm.io/package/inherits.md) ^2.0.1

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 1.2.4 (latest) — 2015-10-21
- 1.2.3 — 2015-10-21
- 1.2.2 — 2015-10-21
- 1.2.1 — 2015-10-20
- 1.2.0 — 2015-10-20
- 1.1.0 — 2015-10-20
- 1.0.1 — 2015-10-18
- 1.0.0 — 2015-10-18

## README

Generic graph structure with ascetic API.

## Usage

[![npm install tolstoy](https://nodei.co/npm/tolstoy.png?mini=true)](https://npmjs.org/package/tolstoy/)

```js
var Graph = require('tolstoy');

//create from a set of nodes
var graph = new Graph([a, b, c]);

//create from a set of connected nodes
graph = new Graph([[a, b], [b, a], [a, c], ...]);

//create from the other graph (clone)
graph = new Graph(graph);

//add node
graph.add(a).add(b);

//delete and disconnect a node
graph.delete(b);

//remove all nodes with their connections
graph.clear();

//test whether node exists
graph.has(a);

//iterate over all nodes
graph.forEach(function (node) {});

//connect node a to b, b to c
graph.connect(a, b).connect(b, c);

//disconnect node b from a, or from all output nodes, if undefined
//if you need to disconnect all inputs, use `delete(a)` and then `add(a)`.
graph.disconnect(b, a?);

//check whether two nodes are connected
graph.isConnected(a, b);

//default serialization
graph.toJSON();
graph.fromJSON(obj);

//set of nodes
graph.nodes;

//map of node’s connected nodes, undirected
graph.edges;

//map of node's input nodes
graph.inputs;

//map of node's output nodes
graph.outputs;
```


## Principles

* Tolstoy does not provide a framework of graph calculations, or rendering facilities — the whole purpose of the project is to provide maximally minimal familiar structure to work with graphs, providing minimally possible set of methods.
* Tolstoy does not try to purport the theoretical purity in sense of directed/undirected/multi/simple graph etc. It provides a basic tiny class to extend on demand to implement any kind of graph-like structure.
* Tolstoy uses ES6 structures beneath, so you may need to polyfill them with [babel](https://babeljs.io/docs/setup/) etc.
* API is as close as possible to native structures like [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map), [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set). Structures should be felt naturally.
* Tolstoy is a temporary solution, akin to [xtend](https://npmjs.org/package/xtend), till there is no native implementation of _Graph_ in node/browsers. As only there is one, tolstoy is going to be replaced with polyfill.

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