Class Workflow

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

Hierarchy

Workflow

Implements

Generable
Conditional

Index

Constructors

constructor

Properties

Accessors

generableType

Methods

Constructors

constructor

new Workflow(name: string, jobs?: (Job | WorkflowJobAbstract)[], when?: When): Workflow

- Defined in src/lib/Components/Workflow/exports/Workflow.ts:39
Instantiate a Workflow

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

Properties

jobs

jobs: WorkflowJobAbstract[] = []

The jobs to execute when this Workflow is triggered.

name

name: string

The name of the Workflow.

Optional when

when?: When

The conditional statement that will be evaluated to determine whether to trigger this workflow.

Accessors

generableType

get generableType(): GenerableType

Implementation of Generable.generableType
- Defined in src/lib/Components/Workflow/exports/Workflow.ts:99
Returns GenerableType

Methods

addJob

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

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

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

addJobApproval

addJobApproval(name: string, parameters?: WorkflowJobParameters): Workflow

- Defined in src/lib/Components/Workflow/exports/Workflow.ts:94
Add a Approval to the current Workflow. Chainable

Parameters
- name: string
- Optional parameters: WorkflowJobParameters
Returns Workflow

generate

generate(flatten?: boolean): WorkflowsShape

Implementation of Generable.generate
- Defined in src/lib/Components/Workflow/exports/Workflow.ts:58
Generate Workflow Shape.

Parameters
- Optional flatten: boolean
Returns WorkflowsShape
The generated JSON for the Workflow.

generateContents

generateContents(flatten?: boolean): WorkflowContentsShape

Implementation of Generable.generateContents
- Defined in src/lib/Components/Workflow/exports/Workflow.ts:67
Generate contents of the Workflow.

Parameters
- Optional flatten: boolean
Returns WorkflowContentsShape

Generated using TypeDoc