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

docs: clarify bootstrap add/remove optional params #557

Merged
merged 1 commit into from
Nov 14, 2019
Merged
Changes from all commits
Commits
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
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