durable-execution - v0.32.0
    Preparing search index...

    Type Alias TaskOptions<TInput, TOutput>

    TaskOptions: CommonTaskOptions & {
        run: (
            ctx: TaskRunContext,
            input: TInput,
        ) => TOutput | Promise<TOutput> | Effect.Effect<TOutput, unknown, never>;
    }

    Options for a task that can be run using a durable executor. A task is resilient to task failures, process failures, network connectivity issues, and other transient errors. The task should be idempotent as it may be run multiple times if there is a process failure or if the task is retried.

    When enqueued with an executor, a task execution handle is returned. It supports getting the execution status, waiting for the task to complete, and cancelling the task.

    The output of the run function is the output of the task.

    The input and output are serialized and deserialized using the serializer passed to the durable executor.

    Make sure the id is unique among all the tasks in the same durable executor. If two tasks are registered with the same id, an error will be thrown.

    The tasks can be added to an executor using the DurableExecutor.task method. If the input to a task needs to be validated, it can be done using the DurableExecutor.validateInput or DurableExecutor.inputSchema methods.

    See the task examples section for more details on creating tasks.

    Type Parameters

    • TInput = undefined
    • TOutput = unknown

    Type Declaration

    • run: (
          ctx: TaskRunContext,
          input: TInput,
      ) => TOutput | Promise<TOutput> | Effect.Effect<TOutput, unknown, never>

      The task run logic. It returns the output.

      Behavior on throwing errors:

      • If the task throws an error, it will be marked as failed
      • If the task throws a {@link DurableExecutionTimedOutError}, it will be marked as timed out
      • If the task throws a {@link DurableExecutionCancelledError}, it will be marked as cancelled
      • Failed and timed out tasks might be retried based on the task's retry configuration
      • Cancelled tasks will not be retried
    const extractFileTitle = executor
      .inputSchema(Schema.Struct({ filePath: Schema.String }))
      .task({
        id: 'extractFileTitle',
        timeoutMs: 30_000, // 30 seconds
        run: async (ctx, input) => {
          // ... extract the file title
          return {
            title: 'File Title',
          }
        },
      })

    Settings

    Member Visibility