Class default

constructor

• new default(workflowTemplate, options?): default

• Parameters

  • workflowTemplate: WorkflowDefinitionSchema
  • Optionaloptions: Partial<WorkflowInitOptions>

  Returns default

currentState

loadedCurrentState

options

template

getCurrentState

• getCurrentState(): WorkflowCurrentState

• For exporting a copy of current state for storage in a database or persistent storage

  Returns WorkflowCurrentState

getCurrentStep

• getCurrentStep(): undefined | WorkflowStep

• Returns undefined | WorkflowStep

getRegisteredResolverForStep

• getRegisteredResolverForStep(stepId): null | WorkflowStepResolver

• Parameters

  • stepId: string

  Returns null | WorkflowStepResolver

getStepMetadata

• getStepMetadata(stepId): {
      inputs?: Record<string, any>;
      [key: string]: any;
  }

• Parameters

  • stepId: string

  Returns {
      inputs?: Record<string, any>;
      [key: string]: any;
  }

  • [key: string]: any

  • Optionalinputs?: Record<string, any>

goAhead

• goAhead(metadata?): boolean

• Parameters

  • Optionalmetadata: {
        inputs?: Record<string, any>;
        [key: string]: any;
    }

    • [key: string]: any

    • Optionalinputs?: Record<string, any>

  Returns boolean

goBack

• goBack(metadata?): boolean

• Parameters

  • Optionalmetadata: {
        inputs?: Record<string, any>;
        [key: string]: any;
    }

    • [key: string]: any

    • Optionalinputs?: Record<string, any>

  Returns boolean

goToStep

• goToStep(stepId, prevStepMetadata?): boolean

• Parameters

  • stepId: string
  • OptionalprevStepMetadata: {
        inputs?: Record<string, any>;
        [key: string]: any;
    }

    • [key: string]: any

    • Optionalinputs?: Record<string, any>

  Returns boolean

loadCurrentState

• loadCurrentState(currentState?): default

• Parameters

  • OptionalcurrentState: WorkflowCurrentState

  Returns default

processCurrentStep

• processCurrentStep(): Promise<any>

• Only for backend and webhook based steps. Use validateStep to process client side interaction based events.

  Returns Promise<any>

processTemplateString

• processTemplateString(str, vars?): string

• Evaluates and interpolates a string based on variables and metadata context/state of the workflow

  Parameters

  • str: string

    String to evaluate
  • Optionalvars: Record<string, any>

    Option: Variables to use for the evaluation

  Returns string

  Evaluated-Interpolated string

registerResolver

• registerResolver(stepId, resolver): WorkflowStepResolver

• Parameters

  • stepId: string
  • resolver: WorkflowStepResolver

  Returns WorkflowStepResolver

setStepMetadata

• setStepMetadata(stepId, metadata): void

• Parameters

  • stepId: string
  • metadata: {
        inputs?: Record<string, any>;
        [key: string]: any;
    }

    • [key: string]: any

    • Optionalinputs?: Record<string, any>

  Returns void

throwIfCurrentStateNotLoaded

• throwIfCurrentStateNotLoaded(): void

• Returns void

validateStepAction

• validateStepAction(stepId, actionId, inputs): Promise<{
      isValid: boolean;
      validationErrors: string[];
  }>

• Client side workflow step validator on proceeding with any action

  Parameters

  • stepId: string
  • actionId: string
  • inputs: Record<string, any>

  Returns Promise<{
      isValid: boolean;
      validationErrors: string[];
  }>