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

Commit

Permalink
feat: documentation of GC using multihashes
Browse files Browse the repository at this point in the history 
Related  to ipfs/js-ipfs#2415
  • Loading branch information
@AuHau
AuHau committed Oct 16, 2019
1 parent 69c5a29 commit b148e21
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions SPEC/REPO.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Where:
- `err` is an Error if the whole GC operation was not successful.
- `res` is an array of objects that contains the following properties
- `err` is an Error if it was not possible to GC a particular block.
- `cid` is the [CID][cid] of the block that was Garbage Collected.
- `multihash` is the [multihashes][] of the block that was Garbage Collected.

If no `callback` is passed, a promise is returned.

Expand Down Expand Up @@ -84,4 +84,4 @@ ipfs.repo.version((err, version) => console.log(version))
```

[1]: https://github.com/MikeMcl/bignumber.js/
[cid]: https://www.npmjs.com/package/cids
[multihashes]: https://www.npmjs.com/package/multihashes

0 comments on commit b148e21

Please sign in to comment.