Class.InParallelStep - DecentM/concourse-ts GitHub Wiki

@decentm/concourse-ts / InParallelStep

Class: InParallelStep

Defined in: components/step/in-parallel.ts:14

Performs steps in parallel. This step is useful for running multiple independent operations concurrently to reduce overall build time.

https://concourse-ci.org/docs/steps/in-parallel/

Extends

Constructors

new InParallelStep()

new InParallelStep(name, customise?): InParallelStep

Defined in: components/step/in-parallel.ts:28

Parameters

name

string

customise?

(instance) => void

Returns

InParallelStep

Overrides

Step<Type.InParallelStep>.constructor

Properties

name

name: string

Defined in: components/step/in-parallel.ts:29

Inherited from

Step.name

Methods

add_across()

add_across(...across): void

Defined in: components/step/base.ts:57

https://concourse-ci.org/docs/steps/modifier-and-hooks/across/#across-step-modifier

Parameters

across

...Across<Identifier>[]

The modifier to add

Returns

void

Inherited from

Step.add_across

add_ensure()

add_ensure(step): void

Defined in: components/step/base.ts:249

Adds a step to always be run after this one.

https://concourse-ci.org/docs/steps/modifier-and-hooks/ensure/#ensure-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_ensure

add_on_abort()

add_on_abort(step): void

Defined in: components/step/base.ts:234

Adds a step to be run after this one is aborted.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-abort/#on_abort-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_abort

add_on_error()

add_on_error(step): void

Defined in: components/step/base.ts:219

Adds a step to be run after this one errors.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-error/#on_error-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_error

add_on_failure()

add_on_failure(step): void

Defined in: components/step/base.ts:204

Adds a step to be run after this one fails.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-failure/#on_failure-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_failure

add_on_success()

add_on_success(step): void

Defined in: components/step/base.ts:189

Adds a step to be run after this one succeeds.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-success/#on_success-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_success

add_steps()

add_steps(...steps): void

Defined in: components/step/in-parallel.ts:52

Adds steps to be executed in parallel.

https://concourse-ci.org/docs/steps/in-parallel/#in_parallel_config-schema

Parameters

steps

...AnyStep[]

The steps to execute in parallel

Returns

void

add_tags()

add_tags(...tags): void

Defined in: components/step/base.ts:174

https://concourse-ci.org/docs/steps/modifier-and-hooks/tags/#tags-step-modifier

Parameters

tags

...string[]

Returns

void

Inherited from

Step.add_tags

set_attempts()

set_attempts(attempts): void

Defined in: components/step/base.ts:81

Sets the number of attempts for this step.

https://concourse-ci.org/docs/steps/modifier-and-hooks/attempts/#attempts-step-modifier

Parameters

attempts

number

Returns

void

Inherited from

Step.set_attempts

set_fail_fast()

set_fail_fast(): void

Defined in: components/step/in-parallel.ts:77

Sets "fail_fast" to true - avoid calling to keep false

https://concourse-ci.org/docs/steps/in-parallel/#in_parallel_config-schema

Returns

void

set_limit()

set_limit(limit): void

Defined in: components/step/in-parallel.ts:66

Sets the maximum number of steps to run at a time. By default all steps are run at once.

https://concourse-ci.org/docs/steps/in-parallel/#in_parallel_config-schema

Parameters

limit

number

Maximum parallel steps

Returns

void

set_timeout()

set_timeout(timeout): void

Defined in: components/step/base.ts:68

https://concourse-ci.org/docs/steps/modifier-and-hooks/timeout/#timeout-step-modifier

Parameters

timeout

DurationInput

Returns

void

Inherited from

Step.set_timeout

customise()

static customise(init): void

Defined in: components/step/in-parallel.ts:24

Customises all InParallelSteps constructed after calling this function.

Type.Customiser

Parameters

init

(instance) => void

Returns

void

customise_base()

static customise_base(init): void

Defined in: components/step/base.ts:28

Customises the base of all Steps constructed after calling this function

Type.Customiser

Parameters

init

(instance) => void

Returns

void

Inherited from

Step.customise_base