SoulFireTask

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.

idCopy Anchor Link

get id(): string

Source

snapshotCopy Anchor Link

The task as last fetched: refresh, wait and cancel update it.

get snapshot(): Readonly<BotTask>

Source

terminalCopy Anchor Link

Completed, cancelled, failed or timed out.

get terminal(): boolean

Source

refreshCopy Anchor Link

refresh(
  options?: CallOptions,
): Effect.Effect<BotTask, SoulFireOperationError>

Source

eventsCopy Anchor Link

The task's events after afterRevision, until it ends. afterRevision defaults to the snapshot's.

events(options?: {
  afterRevision?: bigint;
  call?: CallOptions;
}): Stream.Stream<BotTaskEvent, SoulFireOperationError>

Source

waitCopy Anchor Link

Resolves when the task ends, however it ends.

wait(options?: {
  call?: CallOptions;
}): Effect.Effect<BotTask, SoulFireOperationError>

Source

cancelCopy Anchor Link

cancel(
  reason = "",
  options?: CallOptions,
): Effect.Effect<BotTask, SoulFireOperationError>

Source

resultCopy Anchor Link

Waits for the result. Fails with SoulFireTaskFailed unless it completed.

result(options?: {
  call?: CallOptions;
}): Effect.Effect<
  Result extends DescMessage ? MessageShape<Result> : BotTask,
  SoulFireOperationError
>

Source