Class.TaskStep

@decentm/concourse-ts / TaskStep

Class: TaskStep<Input, Output>

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>

Parameters

• name: string

• customise?

Returns

TaskStep<Input, Output>

Overrides

Step<Type.TaskStep>.constructor

Source

components/step/task.ts:20

Properties

attempts

attempts: number

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

Inherited from

Step.attempts

Source

components/step/base.ts:68

---

image?

optional image: string

Source

components/step/task.ts:51

---

name

name: string

Inherited from

Step.name

Source

components/step/task.ts:21

---

privileged

privileged: boolean

Source

components/step/task.ts:53

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

get_task(): Task<Input, Output>

Returns

Task<Input, Output>

Source

components/step/task.ts:41

---

serialise()

serialise(): TaskStep<Identifier, Identifier>

Returns

TaskStep<Identifier, Identifier>

Overrides

Step.serialise

Source

components/step/task.ts:111

---

set_file()

set_file(file): void

Parameters

• file: string

Returns

void

Source

components/step/task.ts:47

---

set_input_mapping()

set_input_mapping(input, mapped_input): void

Parameters

• input: string

• mapped_input: string

Returns

void

Source

components/step/task.ts:79

---

set_output_mapping()

set_output_mapping(output, mapped_output): void

Parameters

• output: string

• mapped_output: string

Returns

void

Source

components/step/task.ts:87

---

set_params()

set_params(params): void

Parameters

• params: EnvVars

Returns

void

Source

components/step/task.ts:68

---

set_task()

set_task(task): void

Parameters

• task: Task<Input, Output>

Returns

void

Source

components/step/task.ts:37

---

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

---

set_vars()

set_vars(vars): void

Parameters

• vars: Vars

Returns

void

Source

components/step/task.ts:57

---

customise()

static customise(init): void

Parameters

• init

Returns

void

Source

components/step/task.ts:16

---

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