Interface DetachedTask<State>

A handle to a background (detached) task.

interface DetachedTask<State = unknown> {
    snapshotId: string;
    abort(): Promise<
        "failed"
        | "completed"
        | "pending"
        | "expired"
        | "aborted"
        | undefined,
    >;
    poll(opts?: { intervalMs?: number }): AsyncIterable<SessionSnapshot<State>>;
    wait(opts?: { intervalMs?: number }): Promise<SessionSnapshot<State>>;
}

Type Parameters

State = unknown

Index

Properties

Methods

abort poll wait

Properties

`Readonly`snapshotId

snapshotId: string

Methods

abort

abort(): Promise<
    "failed"
    | "completed"
    | "pending"
    | "expired"
    | "aborted"
    | undefined,
>
Aborts the task.

Returns Promise<"failed" | "completed" | "pending" | "expired" | "aborted" | undefined>
- Defined in ai/lib/agent.d.ts:580

poll

poll(opts?: { intervalMs?: number }): AsyncIterable<SessionSnapshot<State>>
Yields status until a terminal state.
Parameters
- Optionalopts: { intervalMs?: number }
Returns AsyncIterable<SessionSnapshot<State>>
- Defined in ai/lib/agent.d.ts:572

wait

wait(opts?: { intervalMs?: number }): Promise<SessionSnapshot<State>>
Resolves when the task reaches a terminal state.
Parameters
- Optionalopts: { intervalMs?: number }
Returns Promise<SessionSnapshot<State>>
- Defined in ai/lib/agent.d.ts:576