Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: correct the ipfs.stats.bw API options object #3984

Closed
wants to merge 1 commit into from
Closed

docs: correct the ipfs.stats.bw API options object #3984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/core-api/STATS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,10 @@ An optional object which may have the following keys:

| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| peer | [PeerId][], [CID][] or `String` | `undefined` | Specifies a peer to print bandwidth for |
| proto | `String` | `undefined` | Specifies a protocol to print bandwidth for |
| poll | `boolean` | `undefined` | Is used to yield bandwidth info at an interval |
| interval | `Number` | `undefined` | The time interval to wait between updating output, if `poll` is `true` |
| timeout | `Number` | `undefined` | A timeout in ms |
| signal | [AbortSignal][] | `undefined` | Can be used to cancel any long running requests started as a result of this call |
| peer | [PeerId][], [CID][] or `String` | `undefined` | Specify a peer to print bandwidth for. |
| proto | `String` | `undefined` | Specify a protocol to print bandwidth for. |
| poll | `boolean` | `undefined` | Yield bandwidth at an interval. |
| interval | `String` | `1s` | Time interval to wait between updating output, if 'poll' is true. This accepts durations such as "300s", "1.5h" or "2h45m". <br/><br/> Valid time units are: "ns", "us" (or "µs"), "ms", "s", "m", "h". |

### Returns

Expand Down