File tree Expand file tree Collapse file tree 1 file changed +6
-1
lines changed Expand file tree Collapse file tree 1 file changed +6
-1
lines changed Original file line number Diff line number Diff line change @@ -16,7 +16,11 @@ Where:
16
16
- ` quiet ` writes a minimal output.
17
17
- ` stream-errors ` stream errors.
18
18
19
- ` callback ` must follow ` function (err, res) {} ` signature, where ` err ` is an Error if the operation was not successful.
19
+ ` callback ` must follow ` function (err, res) {} ` signature, where
20
+ - ` err ` is an Error if the whole GC operation was not successful.
21
+ - ` res ` is an array of objects that contains the following properties
22
+ - ` err ` is an Error if it was not possible to GC a particular block.
23
+ - ` cid ` is the [ CID] [ cid ] of the block that was Garbage Collected.
20
24
21
25
If no ` callback ` is passed, a promise is returned.
22
26
@@ -80,3 +84,4 @@ ipfs.repo.version((err, version) => console.log(version))
80
84
```
81
85
82
86
[ 1 ] : https://github.com/MikeMcl/bignumber.js/
87
+ [ cid ] : https://www.npmjs.com/package/cids
You can’t perform that action at this time.
0 commit comments