Class WorkflowRun

constructor

• new WorkflowRun(o): WorkflowRun

• WorkflowRun constructor

  Parameters

  • o: WorkflowRun | WorkflowRunCfg

  Returns WorkflowRun

context

current_step

Optional error

Optional id

Optional session_id

started_at

Optional started_by

status

Optional status_updated_at

Optional step_start

Optional steps

trigger_id

Optional wait_info

current_step_name

• get current_step_name(): any

• Returns any

toJson

• get toJson(): any

• Returns any

createTrace

• createTrace(step_name, user?): Promise<void>

• Parameters

  • step_name: string

  • Optional user: User

  Returns Promise<void>

delete

• delete(): Promise<void>

• Returns Promise<void>

get_next_step

• get_next_step(step, user?): null | WorkflowStep

• Parameters

  • step: WorkflowStep

  • Optional user: User

  Returns null | WorkflowStep

markAsError

• markAsError(e, step, user?): Promise<void>

• Parameters

  • e: Error

  • step: WorkflowStep

  • Optional user: User

  Returns Promise<void>

popReturnDirectives

• popReturnDirectives(): Promise<any>

• Returns Promise<any>

provide_form_input

• provide_form_input(form_values): Promise<void>

• Parameters

  • form_values: any

  Returns Promise<void>

run

• run(__namedParameters): Promise<any>

• Parameters

  • __namedParameters: {
        api_call?: boolean;
        interactive?: boolean;
        noNotifications?: boolean;
        req?: any;
        trace?: boolean;
        user?: User;
    }

    • Optional api_call?: boolean

    • Optional interactive?: boolean

    • Optional noNotifications?: boolean

    • Optional req?: any

    • Optional trace?: boolean

    • Optional user?: User

  Returns Promise<any>

set_current_step

• set_current_step(stepName): void

• Parameters

  • stepName: string

  Returns void

update

• update(row): Promise<void>

• Parameters

  • row: Row

  Returns Promise<void>

userFormFields

• userFormFields(step0?, user?): Promise<{
      fields: FieldLike[];
      validator?: ((r) => any);
  }>

• Parameters

  • Optional step0: WorkflowStep

  • Optional user: User

  Returns Promise<{
      fields: FieldLike[];
      validator?: ((r) => any);
  }>

user_allowed_to_fill_form

• user_allowed_to_fill_form(user): boolean

• Parameters

  • user: User

  Returns boolean

Static count

• count(where?): Promise<number>

• Parameters

  • Optional where: Where

  Returns Promise<number>

Static create

• create(run_in): Promise<WorkflowRun>

• Parameters

  • run_in: WorkflowRunCfg

  Returns Promise<WorkflowRun>

Static find

• find(where, selectopts?): Promise<WorkflowRun[]>

• Parameters

  • where: Where

  • Optional selectopts: SelectOptions

  Returns Promise<WorkflowRun[]>

Static findOne

• findOne(where, selectopts?): Promise<WorkflowRun>

• Parameters

  • where: Where

  • Optional selectopts: SelectOptions

  Returns Promise<WorkflowRun>

Static getResumableWorkflows

• getResumableWorkflows(): Promise<WorkflowRun[]>

• Returns Promise<WorkflowRun[]>

Static prune

• prune(): Promise<void>

• Returns Promise<void>

Static runResumableWorkflows

• runResumableWorkflows(): Promise<void>

• Returns Promise<void>