Class.LoadVarStep

Class: LoadVarStep

Defined in: components/step/load-var.ts:18

Loads the contents of a file into a local var at runtime. The file must be present in an artifact, and the var can be used in subsequent steps via ((.:var_name)) syntax.

https://concourse-ci.org/docs/steps/load-var/

Extends

Step<LoadVarStep>

Constructors

new LoadVarStep()

new LoadVarStep(name, customise?): LoadVarStep

Defined in: components/step/load-var.ts:32

Parameters

name

string

customise?

(instance) => void

Returns

LoadVarStep

Overrides

Step<Type.LoadVarStep>.constructor

Properties

name

name: string

Defined in: components/step/load-var.ts:33

Inherited from

Step.name

Accessors

var

Get Signature

get var(): Var

Defined in: components/step/load-var.ts:106

Returns a var reference string for use in subsequent steps. The returned string can be interpolated into other step configurations.

Returns

Var

The var reference in ((.:var_name)) format

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

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_file()

set_file(file): void

Defined in: components/step/load-var.ts:71

Sets the path to the file to load. The file must exist in an artifact available to the job.

https://concourse-ci.org/docs/steps/load-var/#load_var-step

Parameters

file

string

Path to the file to load

Returns

void

set_format()

set_format(format): void

Defined in: components/step/load-var.ts:85

Sets how to parse the file contents. Options are 'raw', 'trim', 'yaml', or 'json'. Defaults to 'trim' which removes leading/trailing whitespace.

https://concourse-ci.org/docs/steps/load-var/#load_var-step

Parameters

format

The format to parse as

"json" | "yaml" | "yml" | "trim" | "raw"

Returns

void

set_load_var()

set_load_var(load_var): void

Defined in: components/step/load-var.ts:57

Sets the name of the variable to load the file contents into. The variable can be referenced in subsequent steps using ((.:var_name)) syntax.

https://concourse-ci.org/docs/steps/load-var/#load_var-step

Parameters

load_var

string

The variable name

Returns

void

set_reveal()

set_reveal(): void

Defined in: components/step/load-var.ts:96

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

https://concourse-ci.org/docs/steps/load-var/#load_var-step

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/load-var.ts:28

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