Skip to main content Link Search Menu Expand Document (external link)

ClusterWorkflowEngine.ts overview

Since v1.0.0


Exports Grouped by Category


Constructors

make

Signature

declare const make: Effect.Effect<
  {
    readonly register: (
      workflow: Workflow.Any,
      execute: (
        payload: object,
        executionId: string
      ) => Effect.Effect<unknown, unknown, WorkflowInstance | WorkflowEngine>
    ) => Effect.Effect<void>
    readonly execute: <const Discard extends boolean>(options: {
      readonly workflow: Workflow.Any
      readonly executionId: string
      readonly payload: object
      readonly discard: Discard
    }) => Effect.Effect<Discard extends true ? void : Workflow.Result<unknown, unknown>>
    readonly interrupt: (workflow: Workflow.Any, executionId: string) => Effect.Effect<void>
    readonly activityExecute: (options: {
      readonly activity: Activity.Any
      readonly attempt: number
    }) => Effect.Effect<Workflow.Result<unknown, unknown>, never, WorkflowInstance>
    readonly deferredResult: (
      deferred: DurableDeferred.Any
    ) => Effect.Effect<Option.Option<Schema.ExitEncoded<unknown, unknown, unknown>>, never, WorkflowInstance>
    readonly deferredDone: (options: {
      readonly workflowName: string
      readonly executionId: string
      readonly deferred: DurableDeferred.Any
      readonly exit: Schema.ExitEncoded<unknown, unknown, unknown>
    }) => Effect.Effect<void>
    readonly scheduleClock: (options: {
      readonly workflow: Workflow.Any
      readonly executionId: string
      readonly clock: DurableClock.DurableClock
    }) => Effect.Effect<void>
  },
  never,
  Scope | MessageStorage | Sharding.Sharding
>

Source

Since v1.0.0

Layers

layer

Signature

declare const layer: Layer.Layer<WorkflowEngine, never, MessageStorage | Sharding.Sharding>

Source

Since v1.0.0