feat(async-each): add basic JsDoc typing

2022-07-04 17:37:52 +02:00 · 2022-07-04 17:37:52 +02:00 · dfce56cee8
commit dfce56cee8
parent a6fee2946a
1 changed files with 6 additions and 0 deletions
--- a/@vates/async-each/index.js
+++ b/@vates/async-each/index.js
@ -9,6 +9,12 @@ class AggregateError extends Error {
  }
 }

+/**
+ * @template Item
+ * @param {Iterable<Item>} iterable
+ * @param {(item: Item, index: number, iterable: Iterable<Item>) => Promise<void>} iteratee
+ * @returns {Promise<void>}
+ */
 exports.asyncEach = function asyncEach(iterable, iteratee, { concurrency = 1, signal, stopOnError = true } = {}) {
  if (concurrency === 0) {
    concurrency = Infinity