docs: add JSDoc to Producer

atls · Oct 10, 2024 · 537ec28 · 537ec28
1 parent 790cde6
commit 537ec28
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/nestjs-batch-queue/src/batch-queue/producer.ts b/packages/nestjs-batch-queue/src/batch-queue/producer.ts
@@ -4,6 +4,9 @@ import type { QueueName }  from './types/index.js'
 export class Producer<T> {
   constructor(private batchQueue: BatchQueue<T>) {}
 
+  /**
+   * Delegates to {@link BatchQueue.add}
+   */
   async produce(queueName: QueueName, data: T): Promise<void> {
     await this.batchQueue.add({ queueName, item: data })
   }