@trigger.dev/sdk 0.0.0-prerelease-20251205123936 → 0.0.0-prerelease-20251209103333

package/dist/commonjs/v3/shared.d.ts

@@ -109,6 +109,15 @@ export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<T
  *     payload: { other: "data" }
  *   }
  * ]);
+ *
+ * // Or stream items from an async iterable
+ * async function* generateItems() {
+ *   for (let i = 0; i < 1000; i++) {
+ *     yield { id: "my-task", payload: { index: i } };
+ *   }
+ * }
+ *
+ * const streamResult = await batch.trigger<typeof myTask>(generateItems());
  * ```
  *
  * @description
@@ -128,6 +137,7 @@ export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<T
  *   - `maxDuration`: Maximum execution duration
  */
 export declare function batchTriggerById<TTask extends AnyTask>(items: Array<BatchByIdItem<InferRunTypes<TTask>>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchRunHandleFromTypes<InferRunTypes<TTask>>>;
+export declare function batchTriggerById<TTask extends AnyTask>(items: AsyncIterable<BatchByIdItem<InferRunTypes<TTask>>> | ReadableStream<BatchByIdItem<InferRunTypes<TTask>>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchRunHandleFromTypes<InferRunTypes<TTask>>>;
 /**
  * Triggers multiple tasks and waits for all of them to complete before returning their results.
  * This function must be called from within a task.run() context.
@@ -204,8 +214,23 @@ export declare function batchTriggerById<TTask extends AnyTask>(items: Array<Bat
  * - Payload types
  * - Return value types
  * - Error handling
+ *
+ * You can also pass an AsyncIterable or ReadableStream to stream items:
+ *
+ * @example
+ * ```ts
+ * // Stream items from an async iterable
+ * async function* generateItems() {
+ *   for (let i = 0; i < 1000; i++) {
+ *     yield { id: "child-task", payload: { index: i } };
+ *   }
+ * }
+ *
+ * const results = await batch.triggerAndWait<typeof childTask>(generateItems());
+ * ```
  */
 export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: Array<BatchByIdAndWaitItem<InferRunTypes<TTask>>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByIdResult<TTask>>;
+export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: AsyncIterable<BatchByIdAndWaitItem<InferRunTypes<TTask>>> | ReadableStream<BatchByIdAndWaitItem<InferRunTypes<TTask>>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByIdResult<TTask>>;
 /**
  * Triggers multiple tasks and waits for all of them to complete before returning their results.
  * This function must be called from within a task.run() context.
@@ -282,10 +307,25 @@ export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: Ar
  * - Payload types
  * - Return value types
  * - Error handling
+ *
+ * You can also pass an AsyncIterable or ReadableStream to stream items:
+ *
+ * @example
+ * ```ts
+ * // Stream items from an async iterable
+ * async function* generateItems() {
+ *   for (let i = 0; i < 1000; i++) {
+ *     yield { task: childTask, payload: { index: i } };
+ *   }
+ * }
+ *
+ * const result = await batch.triggerByTask([childTask], generateItems());
+ * ```
  */
 export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(items: {
     [K in keyof TTasks]: BatchByTaskItem<TTasks[K]>;
 }, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchTasksRunHandleFromTypes<TTasks>>;
+export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(items: AsyncIterable<BatchByTaskItem<TTasks[number]>> | ReadableStream<BatchByTaskItem<TTasks[number]>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchTasksRunHandleFromTypes<TTasks>>;
 /**
  * Triggers multiple tasks and waits for all of them to complete before returning their results.
  * This function must be called from within a task.run() context.
@@ -362,7 +402,22 @@ export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(ite
  * - Payload types
  * - Return value types
  * - Error handling
+ *
+ * You can also pass an AsyncIterable or ReadableStream to stream items:
+ *
+ * @example
+ * ```ts
+ * // Stream items from an async iterable
+ * async function* generateItems() {
+ *   for (let i = 0; i < 1000; i++) {
+ *     yield { task: childTask, payload: { index: i } };
+ *   }
+ * }
+ *
+ * const results = await batch.triggerByTaskAndWait([childTask], generateItems());
+ * ```
  */
 export declare function batchTriggerAndWaitTasks<TTasks extends readonly AnyTask[]>(items: {
     [K in keyof TTasks]: BatchByTaskAndWaitItem<TTasks[K]>;
 }, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByTaskResult<TTasks>>;
+export declare function batchTriggerAndWaitTasks<TTasks extends readonly AnyTask[]>(items: AsyncIterable<BatchByTaskAndWaitItem<TTasks[number]>> | ReadableStream<BatchByTaskAndWaitItem<TTasks[number]>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByTaskResult<TTasks>>;