Skip to content
This repository was archived by the owner on Sep 30, 2023. It is now read-only.

Commit b9cb5bc

Browse files
committed
Update API documentation in code
1 parent db1cb28 commit b9cb5bc

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/entry-io.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ class EntryIO {
2525
* @param {Object} [all] Entries to skip
2626
* @param {Number} [amount=-1] How many entries to fetch
2727
* @param {Number} [depth=0] Current depth of the recursion
28-
* @param {function(hash, entry, parent, depth)} onProgressCallback
28+
* @param {function(entry)} shouldExclude A function that can be passed to determine whether a specific hash should be excluded, ie. not fetched. The function should return true to indicate exclusion, otherwise return false.
29+
* @param {function(entry)} onProgressCallback Called when an entry was fetched
2930
* @returns {Promise<Array<Entry>>}
3031
*/
3132
static async fetchAll (ipfs, hashes, { length = -1, exclude = [], shouldExclude, timeout, onProgressCallback, onStartProgressCallback, concurrency = 32, delay = 0 } = {}) {

0 commit comments

Comments
 (0)