Merge pull request #66 from lifeomic/improved-docs

fix: add inline docs for ProcessWithOrdering
lifeomic · Dec 6, 2023 · 67bfee7 · 67bfee7
2 parents 2f46b52 + 1030fe2
commit 67bfee7
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/utils.ts b/src/utils.ts
@@ -47,8 +47,18 @@ export const withHealthCheckHandling =
   };
 
 export type ProcessWithOrderingParams<T> = {
+  /**
+   * The list of items to process.
+   */
   items: T[];
+  /**
+   * A function for determining the "order" of an item. Should return a
+   * string that will be used to order items lexicographically.
+   */
   orderBy: (msg: T) => string;
+  /**
+   * The limit on the number of items to process concurrently at any time.
+   */
   concurrency: number;
 };