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

Commit 1ac0722

Browse files
author
Alan Shaw
authored
docs: clarify bootstrap add/remove optional params (#557)
1 parent f0723e0 commit 1ac0722

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

SPEC/BOOTSTRAP.md

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Although not listed in the documentation, all the following APIs that actually r
2222
- `addr` is a [multiaddr](https://github.com./multiformats/js-multiaddr) to a peer node
2323
- `options.default` if true, add the default peers to the list
2424

25+
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 })`
26+
2527
**Returns**
2628

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

94+
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 })`
95+
9296
**Returns**
9397

9498
| Type | Description |

0 commit comments

Comments
 (0)