Skip to content

Commit

Permalink
docs: clarify bootstrap add/remove optional params (ipfs#557)
Browse files Browse the repository at this point in the history
  • Loading branch information
alanshaw committed Nov 14, 2019
1 parent f0723e0 commit 1ac0722
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions SPEC/BOOTSTRAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Although not listed in the documentation, all the following APIs that actually r
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
- `options.default` if true, add the default peers to the list

Note: If passing the `default` option, `addr` is an optional parameter (may be `undefined`/`null`) and options may be passed as the first argument. i.e. `ipfs.bootstrap.add({ default: true })`

**Returns**

| Type | Description |
Expand Down Expand Up @@ -89,6 +91,8 @@ A great source of [examples][] can be found in the tests for this API.
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
- `options.all` if true, remove all peers from the list

Note: If passing the `all` option, `addr` is an optional parameter (may be `undefined`/`null`) and options may be passed as the first argument. i.e. `ipfs.bootstrap.rm({ all: true })`

**Returns**

| Type | Description |
Expand Down

0 comments on commit 1ac0722

Please sign in to comment.