Class Workflow

A workflow is a set of rules for defining a collection of jobs and their run order.

Hierarchy

Workflow

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Workflow(name: string, jobs?: Job[]): Workflow

- Defined in src/lib/Components/Workflow/index.ts:26
Instantiate a Workflow

Parameters
- name: string
  
  Name your workflow. Must be unique.
- Optional jobs: Job[]
  
  A list of jobs to be executed as part of your Workflow.
Returns Workflow

Properties

jobs

jobs: WorkflowJob[] = []

The jobs to execute when this Workflow is triggered.

name

name: string

The name of the Workflow.

Methods

addJob

addJob(job: Job, parameters?: WorkflowJobParameters): Workflow

- Defined in src/lib/Components/Workflow/index.ts:51
Add a Job to the current Workflow. Chainable

Parameters
- job: Job
- Optional parameters: WorkflowJobParameters
Returns Workflow

generate

generate(): unknown

- Defined in src/lib/Components/Workflow/index.ts:36
Generate Workflow schema.

Returns unknown
The generated JSON for the Workflow.

Generated using TypeDoc