Class.TryStep

@decentm/concourse-ts / TryStep

Class: TryStep

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

Wraps a step to catch any failures and continue the build. If the wrapped step fails, the try step succeeds and subsequent steps will run.

https://concourse-ci.org/docs/steps/try/

Extends

• Step<TryStep>

Constructors

new TryStep()

new TryStep(name, customise?): TryStep

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

Parameters

name

string

customise?

(instance) => void

Returns

TryStep

Overrides

Step<Type.TryStep>.constructor

Properties

name

name: string

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

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_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_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

---

set_try()

set_try(step): void

Defined in: components/step/try.ts:52

Sets the step to attempt. If this step fails, the try step will succeed and execution will continue.

https://concourse-ci.org/docs/steps/try/

Parameters

step

Step<Step>

The step to wrap in try

Returns

void

---

customise()

static customise(init): void

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

Customises all TrySteps 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