Class.DoStep

@decentm/concourse-ts / DoStep

Class: DoStep

Defined in: components/step/do.ts:13

https://concourse-ci.org/do-step.html

Extends

• Step<DoStep>

Constructors

new DoStep()

new DoStep(name, customise?): DoStep

Defined in: components/step/do.ts:27

Parameters

name

string

customise?

(instance) => void

Returns

DoStep

Overrides

Step<Type.DoStep>.constructor

Properties

attempts

attempts: number

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

https://concourse-ci.org/attempts-step.html

Inherited from

Step.attempts

---

name

name: string

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

Inherited from

Step.name

Methods

add_across()

add_across(...across): void

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

https://concourse-ci.org/across-step.html

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:234

Adds a step to always be run after this one.

https://concourse-ci.org/ensure-hook.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_ensure

---

add_on_abort()

add_on_abort(step): void

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

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

https://concourse-ci.org/on-abort-hook.html

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:204

Adds a step to be run after this one errors.

https://concourse-ci.org/on-error-hook.html

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:189

Adds a step to be run after this one fails.

https://concourse-ci.org/on-failure-hook.html

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:174

Adds a step to be run after this one succeeds.

https://concourse-ci.org/on-success-step.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_success

---

add_step()

add_step(step): void

Defined in: components/step/do.ts:49

Adds a step after existing steps into this DoStep

Parameters

step

AnyStep

Returns

void

---

add_step_first()

add_step_first(step): void

Defined in: components/step/do.ts:58

Adds a step that runs before all existing steps in this DoStep

Parameters

step

AnyStep

Returns

void

---

add_tag()

add_tag(...tags): void

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

https://concourse-ci.org/tags-step.html

Parameters

tags

...string[]

Returns

void

Inherited from

Step.add_tag

---

set_timeout()

set_timeout(timeout): void

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

https://concourse-ci.org/timeout-step.html

Parameters

timeout

DurationInput

Returns

void

Inherited from

Step.set_timeout

---

customise()

static customise(init): void

Defined in: components/step/do.ts:23

Customises all DoSteps 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:21

Customises the base of all Steps constructed after calling this function

Type.Customiser

Parameters

init

(instance) => void

Returns

void

Inherited from

Step.customise_base