README
ipfs-stats
This lets you poll peer and node stats from IPFS very easily.
Install
In Node.js through npm
$ npm install --save is-ipfs
Browser: Browserify, Webpack, other bundlers
The code published to npm that gets loaded on require is in fact an ES5 transpiled version with the right shims added. This means that you can require it and use with your favorite bundler without having to adjust asset management process.
const StatsPoller = require('ipfs-stats')
<script>
tag
In the Browser through Loading this module through a script tag will make the IpfsStats
obj available in the global namespace.
<script src="https://unpkg.com/ipfs-stats/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/ipfs-stats/dist/index.js"></script>
API
StatsPoller
Class
new StatsPoller(ipfs, [frequency])
ipfs
Object. IPFS API Object.frequency
Integer (optional). The frequency, in milliseconds, to push new stats. Defaults to1000
.
Properties
poller.stats
retrieves the current stats. It should contain the fieldsbw
,id
,peers
andrepo
.
Methods
poller.start([opts])
tells the poller to start polling theopts
.poller.stop([opts])
tells the poller to stop polling theopts
.
opts
is an Array of strings. Default is ['bw', 'id', 'peers', 'repo']
. Beware that the id
poller only runs once because
the ID stats are the same throughout the lifespan of the daemon.
Events
change