Skip to content

Class.LoadVarStep

DecentM edited this page Aug 27, 2024 · 57 revisions

@decentm/concourse-ts / LoadVarStep

Class: LoadVarStep

Extends

Constructors

new LoadVarStep()

new LoadVarStep(name, customise?): LoadVarStep

Parameters

name: string

customise?

Returns

LoadVarStep

Overrides

Step<Type.LoadVarStep>.constructor

Source

components/step/load-var.ts:18

Properties

attempts

attempts: number

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

Inherited from

Step.attempts

Source

components/step/base.ts:68


file?

optional file: string

Source

components/step/load-var.ts:35


format?

optional format: "json" | "yaml" | "yml" | "trim" | "raw"

Source

components/step/load-var.ts:37


load_var?

optional load_var: string

Source

components/step/load-var.ts:33


name

name: string

Inherited from

Step.name

Source

components/step/load-var.ts:19


reveal

reveal: boolean

Source

components/step/load-var.ts:39

Accessors

var

get var(): Var

Returns

Var

Source

components/step/load-var.ts:41

Methods

add_across()

add_across(...across): void

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

Parameters

• ...across: Across<Identifier>[]

The modifier to add

Returns

void

Inherited from

Step.add_across

Source

components/step/base.ts:50


add_ensure()

add_ensure(step): void

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

Source

components/step/base.ts:234


add_on_abort()

add_on_abort(step): void

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

Source

components/step/base.ts:219


add_on_error()

add_on_error(step): void

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

Source

components/step/base.ts:204


add_on_failure()

add_on_failure(step): void

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

Source

components/step/base.ts:189


add_on_success()

add_on_success(step): void

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

Source

components/step/base.ts:174


add_tag()

add_tag(...tags): void

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

Parameters

• ...tags: string[]

Returns

void

Inherited from

Step.add_tag

Source

components/step/base.ts:159


get_resources()

get_resources(): Resource<Config, Config, Config>[]

Returns

Resource<Config, Config, Config>[]

Overrides

Step.get_resources

Source

components/step/load-var.ts:54


serialise()

serialise(): LoadVarStep

Returns

LoadVarStep

Overrides

Step.serialise

Source

components/step/load-var.ts:58


set_timeout()

set_timeout(timeout): void

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

Parameters

timeout: DurationInput

Returns

void

Inherited from

Step.set_timeout

Source

components/step/base.ts:61


customise()

static customise(init): void

Parameters

init

Returns

void

Source

components/step/load-var.ts:14


customise_base()

static customise_base(init): void

Customises the base of all Steps constructed after calling this function

Type.Customiser

Parameters

init

Returns

void

Inherited from

Step.customise_base

Source

components/step/base.ts:21

Clone this wiki locally