Class.TaskStep

@decentm/concourse-ts / TaskStep

Class: TaskStep<Input, Output>

Defined in: components/step/task.ts:10

Extends

Step<TaskStep>

Type Parameters

• Input extends Identifier = Identifier

• Output extends Identifier = Identifier

Constructors

new TaskStep()

new TaskStep<Input, Output>(name, customise?): TaskStep<Input, Output>

Defined in: components/step/task.ts:20

Parameters

name

string

customise?

(instance) => void

Returns

TaskStep<Input, Output>

Overrides

Step<Type.TaskStep>.constructor

Properties

attempts

attempts: number

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

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

Inherited from

Step.attempts

image?

optional image: string

Defined in: components/step/task.ts:51

name

name: string

Defined in: components/step/task.ts:21

Inherited from

Step.name

privileged

privileged: boolean

Defined in: components/step/task.ts:53

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

add_tag(...tags): void

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

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

Parameters

Returns

void

Inherited from

Step.add_tag

get_task()

get_task(): Task<Input, Output>

Defined in: components/step/task.ts:41

Returns

Task<Input, Output>

set_file()

set_file(file): void

Defined in: components/step/task.ts:47

Parameters

file

string

Returns

void

set_input_mapping()

set_input_mapping(input, mapped_input): void

Defined in: components/step/task.ts:79

Parameters

input

string

mapped_input

string

Returns

void

set_output_mapping()

set_output_mapping(output, mapped_output): void

Defined in: components/step/task.ts:87

Parameters

output

string

mapped_output

string

Returns

void

set_params()

set_params(params): void

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

Parameters

params

EnvVars

Returns

void

set_task()

set_task(task): void

Defined in: components/step/task.ts:37

Parameters

task

Task<Input, Output>

Returns

void

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

set_vars()

set_vars(vars): void

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

Parameters

vars

Vars

Returns

void

customise()

static customise(init): void

Defined in: components/step/task.ts:16

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