Class Run<O>

constructor

• new Run<O>(engine: Engine, id: string): Run<O>

  Type Parameters

  • O

  Parameters

  • engine: Engine
  • id: string

  Returns Run<O>

Readonlyid

cancel

• cancel(reason?: string): Promise<void>

  Parameters

  • reason: string = "cancelled"

  Returns Promise<void>

describe

• describe(): Promise<RunDetail>

  The run and its journal (each record with its kind), and for a key of an object type its state. Throws NotFoundError for an unknown ID.

  Returns Promise<RunDetail>

inspect

• inspect(): any

  Returns any

  Deprecated

  Use describe().

query

• query<R, A = unknown>(q: string | QueryDefinition<A, R>, arg?: A): Promise<R>

  Calls a query handler; the answer waits until the state it read is durable.

  Type Parameters

  • R
  • A = unknown

  Parameters

  • q: string | QueryDefinition<A, R>
  • Optionalarg: A

  Returns Promise<R>

reset

• reset(
      opts: { beforeStep: string; reapplySignals?: boolean; version?: number },
  ): Promise<void>

  Starts a new run whose journal is this one's cut just before beforeStep.

  Parameters

  • opts: { beforeStep: string; reapplySignals?: boolean; version?: number }

  Returns Promise<void>

result

• result(): Promise<O>

  Waits for the run's result (following continue-as-new and reset).

  Returns Promise<O>

resume

• resume(): Promise<void>

  Resumes a run that paused because a step ran out of retries (retry: { onExhausted: "pause" }): the step runs again at once, with a fresh set of attempts, on the code this process has now. Rejected if nothing is paused.

  Returns Promise<void>

retry

• retry(): Promise<void>

  Runs a failed run again from its failed step (a reset before it, with its signals).

  Returns Promise<void>

signal

• signal<T>(sig: string | SignalDefinition<T>, value: T): Promise<void>

  Sends a signal (a definition or its name); resolves once it is durable.

  Type Parameters

  • T

  Parameters

  • sig: string | SignalDefinition<T>
  • value: T

  Returns Promise<void>

started

• started(): Promise<void>

  Waits until a run with this ID exists. A debounced or batched run starts only when its window closes; until then result fails with NotFound.

  Returns Promise<void>

status

• status(): Promise<RunSummary>

  The run's summary: status, type, version, times, error.

  Returns Promise<RunSummary>

stream

• stream<T = unknown>(name: string, opts?: StreamOptions): StreamReader<T>

  A reader of the run's stream name (for await (const chunk of run.stream("tokens"))).

  Type Parameters

  • T = unknown

  Parameters

  • name: string
  • opts: StreamOptions = {}

  Returns StreamReader<T>

terminate

• terminate(reason?: string): Promise<void>

  Ends the run at once; children follow their parent close policy.

  Parameters

  • reason: string = "terminated"

  Returns Promise<void>

update

• update<A, R>(
      upd: string | UpdateDefinition<A, R>,
      arg: A,
      opts?: UpdateOptions,
  ): Promise<R>

  Sends an update and waits for its handler's durable result.

  Type Parameters

  • A
  • R

  Parameters

  • upd: string | UpdateDefinition<A, R>
  • arg: A
  • opts: UpdateOptions = {}

  Returns Promise<R>