Stable task identifier for later lookup, observation, or cancellation.
Whether the cached status is completed, cancelled, failed, or timed out.
This property does not fetch current state. Use refresh for a new snapshot.
Request task cancellation and update the cached snapshot.
Explanation recorded with the cancellation request.
Optionaloptions: CallOptions
RPC call options; the SDK includes any active control token.
An Effect that produces the server's updated task snapshot.
Observe task revisions until the task ends.
Optionaloptions: { afterRevision?: bigint; call?: CallOptions }
Revision to resume after and RPC call options. The revision defaults to the cached snapshot's revision when the stream opens.
A lazy Stream of task events.
Direct consumption does not update snapshot. Closing this observer does not cancel the server task.
Fetch current server state and update snapshot.
Optionaloptions: CallOptions
RPC call options.
An Effect that produces the latest task snapshot.
Wait for successful completion and decode the typed task result.
Optionaloptions: { call?: CallOptions }An Effect that produces the result selected by the start method. Without a result schema, it produces the completed task snapshot.
Failure, cancellation, timeout, or a missing or incompatible result fails
with SoulFireTaskFailed in the Effect error channel. The error retains the
server task snapshot. Interrupting this wait does not itself cancel the task.
wait to inspect unsuccessful terminal states.
Wait for a terminal state and update snapshot.
Optionaloptions: { call?: CallOptions }An Effect that produces a snapshot for any terminal status, including failure and cancellation. Use result to require success.
A handle for a server task with a typed result.
Starting a task waits for acceptance, not completion. Server lifecycle policies control execution after acceptance. Use wait to inspect terminal status, or result to require successful completion and decode the result.
Remarks
Observing this handle does not take ownership of the job. Interrupting an observer or result wait does not itself cancel it. Call cancel, use a
run*stream, or use SoulFireBot.collect for cancellation ownership.