From 1030fe20f864faee7bb49c395dc2496929b24023 Mon Sep 17 00:00:00 2001
From: Swain Molster <swain.molster@lifeomic.com>
Date: Wed, 6 Dec 2023 17:11:09 -0500
Subject: [PATCH] fix: add inline docs for ProcessWithOrdering

---
 src/utils.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/utils.ts b/src/utils.ts
index 595c902..3a199b4 100644
--- 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;
 };