# libp2p-railing

> Node.js IPFS Implementation of the railing process of a Node through a bootstrap peer list

Latest version **0.9.2** (published 2018-06-29) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install libp2p-railing
pnpm add libp2p-railing
yarn add libp2p-railing
bun add libp2p-railing
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.9.2 |
| Published | 2018-06-29 |
| First published | 2015-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 6 |
| Unpacked size | 5.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Maintainers | daviddias, dignifiedquire |
| Keywords | IPFS |

## Links

- npm: https://www.npmjs.com/package/libp2p-railing
- Repository: https://github.com/libp2p/js-libp2p-railing
- Homepage: https://github.com/libp2p/js-ipfs-railing
- Issues: https://github.com/libp2p/js-ipfs-railing/issues
- npm.io page: https://npm.io/package/libp2p-railing

## Dependencies (6)

- [async](https://npm.io/package/async.md) ^2.6.1
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [mafmt](https://npm.io/package/mafmt.md) ^6.0.0
- [peer-id](https://npm.io/package/peer-id.md) ~0.10.7
- [multiaddr](https://npm.io/package/multiaddr.md) ^5.0.0
- [peer-info](https://npm.io/package/peer-info.md) ~0.14.1

## Recent versions

- 0.9.2 (latest) — 2018-06-29
- 0.9.1 — 2018-06-05
- 0.9.0 — 2018-06-05
- 0.8.1 — 2018-04-12
- 0.8.0 — 2018-04-05
- 0.7.1 — 2017-09-08
- 0.7.0 — 2017-09-03
- 0.6.1 — 2017-07-23
- 0.6.0 — 2017-07-22
- 0.5.2 — 2017-07-08
- 0.5.1 — 2017-05-19
- 0.5.0 — 2017-03-30
- 0.4.3 — 2017-03-23
- 0.4.2 — 2017-03-21
- 0.4.1 — 2017-02-09
- … 4 more at https://npm.io/package/libp2p-railing/versions

## README

js-libp2p-railing
=================

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-railing/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-railing?branch=master)
[![Travis CI](https://travis-ci.org/libp2p/js-libp2p-railing.svg?branch=master)](https://travis-ci.org/libp2p/js-libp2p-railing)
[![Circle CI](https://circleci.com/gh/libp2p/js-libp2p-railing.svg?style=svg)](https://circleci.com/gh/libp2p/js-libp2p-railing)
[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-railing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-railing)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

> JavaScript libp2p Implementation of the railing process of a Node through a bootstrap peer list

## Lead Maintainer

[Vasco Santos](https://github.com/vasco-santos).

## Usage

```JavaScript
const Railing = require('libp2p-railing')

const options = {
  list: <List of Multiaddrs>
  interval: 5000 // ms, default is 10s
}

const b = new Railing(options)

b.on('peer', function (peerInfo) {
  // found a new peer
})

b.start()
```

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