Type Alias WorkflowContext

Type declaration

• COUNTER: {
      counter: number;
  }

  • counter: number

    the reentrant semaphore parent counter object for object reference during increment

• canRetry: boolean

  can the workflow be retried if an error occurs

• connection: Connection

  the HotMesh connection configuration (io/redis NPM package reference and login credentials)

• counter: number

  the reentrant semaphore, incremented in real-time as idempotent statements are re-traversed upon reentry. Indicates the current semaphore count.

• cursor: string

  number as string for the replay cursor

• Optionalexpire?: number

  if present, the workflow will delay expiration for the specified number of seconds

• interruptionRegistry: any[]

  holds list of interruption payloads; if list is longer than 1 when the error is thrown, a collator subflow will be used

• namespace: string

  the HotMesh App namespace

  Default

  meshflow
  Copy

• originJobId: string

  entry point ancestor flow; might be the parent; will never be self

• raw: StreamData

  the native HotMesh message that encapsulates the arguments, metadata, and raw data for the workflow

• replay: StringStringType

  the replay hash of name/value pairs representing prior executions

• workflowDimension: string

  the dimensional isolation for the reentrant hook, expressed in the format 0,0, 0,1, etc

• workflowId: string

  the workflow/job ID

• workflowSpan: string

  the open telemetry span context for the workflow, used for logging and tracing. If a sink is enabled, this will be sent to the sink.

• workflowTopic: string

  a concatenation of the task queue and workflow name (e.g., ${taskQueueName}-${workflowName})

• workflowTrace: string

  the open telemetry trace context for the workflow, used for logging and tracing. If a sink is enabled, this will be sent to the sink.