Class RemoteRun<O>

constructor

• new RemoteRun<O = unknown>(client: Client, id: string): RemoteRun<O>

  Type Parameters

  • O = unknown

  Parameters

  • client: Client
  • id: string

  Returns RemoteRun<O>

Readonlyid

cancel

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

  Parameters

  • reason: string = "cancelled"

  Returns Promise<void>

describe

• describe(): Promise<RunDetail>

  The run and its journal (as Run.describe).

  Returns Promise<RunDetail>

query

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

  Type Parameters

  • R
  • A = unknown

  Parameters

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

  Returns Promise<R>

reset

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

  As Run.reset: { beforeStep, reapplySignals } (a step name alone works too).

  Parameters

  • opts: string | { beforeStep: string; reapplySignals?: boolean }
  • reapplySignals: boolean = true

  Returns Promise<void>

result

• result(): Promise<O>

  Returns Promise<O>

resume

• resume(): Promise<void>

  Resumes a paused run: its step runs again with a fresh set of attempts.

  Returns Promise<void>

retry

• retry(): Promise<void>

  Runs a failed run again from its failed step.

  Returns Promise<void>

signal

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

  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 when its window closes).

  Returns Promise<void>

status

• status(): Promise<RunSummary>

  The run's summary (as Run.status).

  Returns Promise<RunSummary>

stream

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

  A reader of the run's stream name, answered by the worker holding its shard.

  Type Parameters

  • T = unknown

  Parameters

  • name: string
  • opts: StreamOptions = {}

  Returns StreamReader<T>

terminate

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

  Parameters

  • reason: string = "terminated"

  Returns Promise<void>

update

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

  Type Parameters

  • A
  • R

  Parameters

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

  Returns Promise<R>