Class Step

An interface step which allows GET requests to be made against the interface itself.

Hierarchy

Step

Index

Properties

Accessors

Properties

Protected _callback

_callback: any

Callback function to run on step execution.

Protected _complete

_complete: boolean

Flag if step is complete or not

Protected _failure

_failure: string

Step validation error.

Protected _name

_name: string

The human-readable step _name.

Accessors

callback

get callback(): function
set callback(callback: function): void

- Defined in lib/ui/step.ts:40
Returns function
- - (job: Job, ui: WebhookInterface, step: Step): void
  - Parameters
    - job: Job
    - ui: WebhookInterface
    - step: Step
    Returns void
- Defined in lib/ui/step.ts:36
Parameters
- callback: function
  - - (job: Job, ui: WebhookInterface, step: Step): void
    - Parameters
      - job: Job
      - ui: WebhookInterface
      - step: Step
      Returns void
Returns void

complete

get complete(): boolean
set complete(complete: boolean): void

- Defined in lib/ui/step.ts:66
Set complete and wipe out any failure

Returns boolean
- Defined in lib/ui/step.ts:56
Set complete and wipe out any failure

Parameters
- complete: boolean
Returns void

failure

get failure(): string
set failure(message: string): void

- Defined in lib/ui/step.ts:32
Returns string
- Defined in lib/ui/step.ts:28
Parameters
- message: string
Returns void

name

get name(): string
set name(name: string): void

- Defined in lib/ui/step.ts:44
Returns string
- Defined in lib/ui/step.ts:48
Parameters
- name: string
Returns void

Generated using TypeDoc