Added some JSDocs

Author: matt-aitken

packages/core/src/v3/schemas/queues.ts

@@ -1,18 +1,36 @@
 import { z } from "zod";
 
+/**
+ * The type of queue, either "task" or "custom"
+ * "task" are created automatically for each task.
+ * "custom" are created by you explicitly in your code.
+ * */
 export const QueueType = z.enum(["task", "custom"]);
 export type QueueType = z.infer<typeof QueueType>;
 
 export const QueueItem = z.object({
+  /** The queue name */
   name: z.string(),
+  /**
+   * The queue type, either "task" or "custom"
+   * "task" are created automatically for each task.
+   * "custom" are created by you explicitly in your code.
+   * */
   type: QueueType,
+  /** The number of runs currently running */
   running: z.number(),
+  /** The number of runs currently queued */
   queued: z.number(),
+  /** The concurrency limit of the queue */
   concurrencyLimit: z.number().nullable(),
 });
 
+export type QueueItem = z.infer<typeof QueueItem>;
+
 export const ListQueueOptions = z.object({
+  /** The page number */
   page: z.number().optional(),
+  /** The number of queues per page */
   perPage: z.number().optional(),
 });
 

packages/trigger-sdk/src/v3/queues.ts

@@ -9,11 +9,11 @@ import {
 import { tracer } from "./tracer.js";
 
 /**
- * Lists schedules
+ * Lists queues
  * @param options - The list options
  * @param options.page - The page number
- * @param options.perPage - The number of schedules per page
- * @returns The list of schedules
+ * @param options.perPage - The number of queues per page
+ * @returns The list of queues
  */
 export function list(
   options?: ListQueueOptions,