Pipeline

Index

Constructors

• constructor

Properties

• events
• id
• name
• parent
• state
• tasks

Accessors

• path
• paths

Methods

• getReport
• run

Constructors

constructor

• new Pipeline(tasks?: string[], name?: string, parent?: Pipeline, events?: EventEmitter): Pipeline

• Orchestrates running sub commands and nested pipelines

  ---

  Parameters

  • tasks: string[] = []

    array of strings or nested objects that define a pipeline

  • optionalname: string

    the name of the pipeline

  • optionalparent: Pipeline

    the parent Pipeline

  • optionalevents: EventEmitter

    the parent Pipeline’s event emitter

  Returns Pipeline

Properties

events

events: EventEmitter

id

id: string

name

name: undefined | string

parent

parent: undefined | Pipeline

state

state: string

tasks

tasks: (Command | Pipeline)[]

Accessors

path

• get path(): string

• Returns string

paths

• get paths(): string[]

• Returns string[]

Methods

getReport

• getReport(): PipelineReport

• Gets information for the pipeline and its children

  ---

  Returns PipelineReport

run

• run(options?: { ignore?: string[] }): Promise<string>

• runs the pipeline and its children recursively

  ---

  Parameters

  • options: { ignore?: string[] } = {}

    an options block that contains overrides

  Returns Promise<string>