Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 49defc6

Browse files
authored
Update STATS.md
1 parent 225b427 commit 49defc6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

SPEC/STATS.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Stats API
1111

1212
#### `bw`
1313

14-
> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
14+
> Get IPFS bandwidth information as an object.
1515
1616
##### `Go` **WIP**
1717

@@ -49,21 +49,24 @@ ipfs.stats.bw((err, stats) => console.log(stats))
4949

5050
#### `bwPullStream`
5151

52-
> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
52+
> Get IPFS bandwidth information as an [Pull Stream][ps].
5353
5454
##### `Go` **WIP**
5555

5656
##### `JavaScript` - ipfs.stats.bwPullStream([options]) -> [Pull Stream][ps]
5757

58+
Options are described on [`ipfs.stats.bw`](#bw).
5859

5960
#### `bwReadableStream`
6061

61-
> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
62+
> Get IPFS bandwidth information as an [Readable Stream][rs].
6263
6364
##### `Go` **WIP**
6465

6566
##### `JavaScript` - ipfs.stats.bwReadableStream([options]) -> [Readable Stream][rs]
6667

68+
Options are described on [`ipfs.stats.bw`](#bw).
69+
6770
[big]: https://github.com/MikeMcl/big.js/
6871
[rs]: https://www.npmjs.com/package/readable-stream
6972
[ps]: https://www.npmjs.com/package/pull-stream

0 commit comments

Comments
 (0)