Class ObjectRef

Readonlykey

Readonlytype

id

• get id(): string

  The key's workflow ID (<type>/<key>).

  Returns string

call

• call<R = unknown, A = unknown>(
      handler: string,
      arg?: A,
      opts?: CallOptions,
  ): Promise<R>

  Calls a handler and waits for its durable result.

  Type Parameters

  • R = unknown
  • A = unknown

  Parameters

  • handler: string
  • Optionalarg: A
  • opts: CallOptions = {}

  Returns Promise<R>

clearState

• clearState(field?: string, opts?: EditOptions): Promise<EditResult>

  Clears one field, or (none named) the whole state; the key remains.

  Parameters

  • Optionalfield: string
  • opts: EditOptions = {}

  Returns Promise<EditResult>

delete

• delete(): Promise<void>

  Deletes the key: its run ends and its state with it; the next call starts empty.

  Returns Promise<void>

editState

• editState(edit: StateEdit, opts?: EditOptions): Promise<EditResult>

  Edits the state from outside its handlers: an exclusive call, so it waits for the key and commits as a handler's writes do.

  Parameters

  • edit: StateEdit
  • opts: EditOptions = {}

  Returns Promise<EditResult>

inspect

• inspect(): any

  The key's run: its journal, and object with its state and pending calls.

  Returns any

patchState

• patchState(ops: JsonPatchOp[], opts?: EditOptions): Promise<EditResult>

  Applies a JSON Patch (RFC 6902) to the state as one JSON object.

  Parameters

  • ops: JsonPatchOp[]
  • opts: EditOptions = {}

  Returns Promise<EditResult>

send

• send<A = unknown>(handler: string, arg?: A, opts?: CallOptions): Promise<void>

  Calls a handler without waiting for its result: resolves once the call is accepted.

  Type Parameters

  • A = unknown

  Parameters

  • handler: string
  • Optionalarg: A
  • opts: CallOptions = {}

  Returns Promise<void>

setState

• setState(field: string, value: unknown, opts?: EditOptions): Promise<EditResult>

  Sets one field of the state.

  Parameters

  • field: string
  • value: unknown
  • opts: EditOptions = {}

  Returns Promise<EditResult>

state

• state<T = Record<string, unknown>>(): Promise<T>

  The committed state ({} for a key never called), once it is durable.

  Type Parameters

  • T = Record<string, unknown>

  Returns Promise<T>