# peer-star-network-vis

> Peer-* collaboration network visualization.

Latest version **0.1.2** (published 2018-08-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install peer-star-network-vis
pnpm add peer-star-network-vis
yarn add peer-star-network-vis
bun add peer-star-network-vis
```

## 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.2 |
| Published | 2018-08-16 |
| First published | 2018-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pedro Teixeira |
| Maintainers | pgte |
| Keywords | ipfs, peer-*, peer-star, collaboration, network, visualization |

## Links

- npm: https://www.npmjs.com/package/peer-star-network-vis
- Repository: https://github.com/ipfs-shipyard/peer-star-network-vis
- Homepage: https://github.com/ipfs-shipyard/peer-star-network-vis#readme
- Issues: https://github.com/ipfs-shipyard/peer-star-network-vis/issues
- npm.io page: https://npm.io/package/peer-star-network-vis

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) ^5.5.0
- [peer-star-peer-color](https://npm.io/package/peer-star-peer-color.md) ^0.1.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2018-08-16
- 0.1.1 — 2018-08-16
- 0.1.0 — 2018-08-16

## README

# peer-star-network-vis

[Peer-*](https://github.com/ipfs-shipyard/peer-star-app) collaboration network visualization.

[![made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)

![Example](docs/example.png)

## Example

```js
const PeerStar = require('peer-star-app')
const NetworkVis = require('peer-star-network-vis')

dApp = PeerStar('my app')
await dApp.start()
collaboration = await dApp.collaborate('collaboration name', ...)

// inside my render function
const svg = document.getElementById('my-svg')

const vis = NetworkVis(collaboration, svg)

// later...

vis.stop()
```

## API

A NetworkVis instance emits the following events:

### emit('selected peer', peerId)

When a peer is selected by the user.


### emit('peer stats updated', { peerId, stats })

When the stats for a given peer is updated.

The `stats` object schema is defined in [`peer-star-app`](github.com/ipfs-shipyard/peer-star-app#readme).


## License

MIT

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