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

docs: pin.add, pin.rm are recursive by default #303

Merged
merged 1 commit into from
Jun 17, 2018
Merged

docs: pin.add, pin.rm are recursive by default #303

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
4 changes: 2 additions & 2 deletions SPEC/PIN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Where:

- `hash` is an IPFS multihash.
- `options` is an object that can contain the following keys
- 'recursive' - Recursively pin the object linked. Type: bool. Default: `false`
- 'recursive' - Recursively pin the object linked. Type: bool. Default: `true`

`callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res` is an array of objects that represent the files that were pinned. Example:

Expand Down Expand Up @@ -76,7 +76,7 @@ A great source of [examples][] can be found in the tests for this API.
Where:
- `hash` is a multihash.
- `options` is an object that can contain the following keys
- 'recursive' - Recursively unpin the object linked. Type: bool. Default: `false`
- 'recursive' - Recursively unpin the object linked. Type: bool. Default: `true`

`callback` must follow `function (err) {}` signature, where `err` is an error if the operation was not successful.

Expand Down