Class WorkflowStepAbstract

constructor

• new WorkflowStep(): CloudflareWorkersModule.WorkflowStep

  Returns CloudflareWorkersModule.WorkflowStep

sleep

sleepUntil

do

• do<T extends Serializable<T>>(
      name: string,
      callback: (ctx: CloudflareWorkersModule.WorkflowStepContext) => Promise<T>,
      rollbackOptions?: CloudflareWorkersModule.WorkflowStepRollbackOptions<
          T,
          CloudflareWorkersModule.WorkflowSleepDuration,
      >,
  ): Promise<T>

  Type Parameters

  • T extends Serializable<T>

  Parameters

  • name: string
  • callback: (ctx: CloudflareWorkersModule.WorkflowStepContext) => Promise<T>
  • OptionalrollbackOptions: CloudflareWorkersModule.WorkflowStepRollbackOptions<
        T,
        CloudflareWorkersModule.WorkflowSleepDuration,
    >

  Returns Promise<T>

• do<T extends Serializable<T>>(
      name: string,
      config: CloudflareWorkersModule.WorkflowStepConfigWithDelayFunction,
      callback: (
          ctx: CloudflareWorkersModule.WorkflowStepContext<
              CloudflareWorkersModule.WorkflowDelayFunction,
          >,
      ) => Promise<T>,
      rollbackOptions?: CloudflareWorkersModule.WorkflowStepRollbackOptions<
          T,
          CloudflareWorkersModule.WorkflowDelayFunction,
      >,
  ): Promise<T>

  Type Parameters

  • T extends Serializable<T>

  Parameters

  • name: string
  • config: CloudflareWorkersModule.WorkflowStepConfigWithDelayFunction
  • callback: (
        ctx: CloudflareWorkersModule.WorkflowStepContext<
            CloudflareWorkersModule.WorkflowDelayFunction,
        >,
    ) => Promise<T>
  • OptionalrollbackOptions: CloudflareWorkersModule.WorkflowStepRollbackOptions<
        T,
        CloudflareWorkersModule.WorkflowDelayFunction,
    >

  Returns Promise<T>

• do<T extends Serializable<T>>(
      name: string,
      config: CloudflareWorkersModule.WorkflowStepConfigWithStaticDelay,
      callback: (
          ctx: CloudflareWorkersModule.WorkflowStepContext<
              CloudflareWorkersModule.WorkflowSleepDuration,
          >,
      ) => Promise<T>,
      rollbackOptions?: CloudflareWorkersModule.WorkflowStepRollbackOptions<
          T,
          CloudflareWorkersModule.WorkflowSleepDuration,
      >,
  ): Promise<T>

  Type Parameters

  • T extends Serializable<T>

  Parameters

  • name: string
  • config: CloudflareWorkersModule.WorkflowStepConfigWithStaticDelay
  • callback: (
        ctx: CloudflareWorkersModule.WorkflowStepContext<
            CloudflareWorkersModule.WorkflowSleepDuration,
        >,
    ) => Promise<T>
  • OptionalrollbackOptions: CloudflareWorkersModule.WorkflowStepRollbackOptions<
        T,
        CloudflareWorkersModule.WorkflowSleepDuration,
    >

  Returns Promise<T>

• do<T extends Serializable<T>>(
      name: string,
      config: CloudflareWorkersModule.WorkflowStepConfig,
      callback: (ctx: CloudflareWorkersModule.WorkflowStepContext) => Promise<T>,
      rollbackOptions?: CloudflareWorkersModule.WorkflowStepRollbackOptions<
          T,
          CloudflareWorkersModule.WorkflowSleepDuration,
      >,
  ): Promise<T>

  Type Parameters

  • T extends Serializable<T>

  Parameters

  • name: string
  • config: CloudflareWorkersModule.WorkflowStepConfig
  • callback: (ctx: CloudflareWorkersModule.WorkflowStepContext) => Promise<T>
  • OptionalrollbackOptions: CloudflareWorkersModule.WorkflowStepRollbackOptions<
        T,
        CloudflareWorkersModule.WorkflowSleepDuration,
    >

  Returns Promise<T>

waitForEvent

• waitForEvent<T extends Serializable<T>>(
      name: string,
      options: {
          timeout?: CloudflareWorkersModule.WorkflowSleepDuration;
          type: string;
      },
  ): Promise<CloudflareWorkersModule.WorkflowStepEvent<T>>

  Type Parameters

  • T extends Serializable<T>

  Parameters

  • name: string
  • options: { timeout?: CloudflareWorkersModule.WorkflowSleepDuration; type: string }

  Returns Promise<CloudflareWorkersModule.WorkflowStepEvent<T>>