Class Step<C, D>

A step is a value object around a function that takes context as first argument.

Type Parameters

C
D

Hierarchy

Timed<D, Error>
- Step

Index

Constructors

Properties

description? ended? failed? impl log name result? started?

Accessors

Methods

call end fail start succeed from

Constructors

constructor

new Step<C, D>(impl, name?, description?, log?): Step<C, D>
Type Parameters
- C
- D
Parameters
- impl: StepFn<C, D>
- name: string = impl.name
- Optional description: string
- log: Core.Console = ...
Returns Step<C, D>
Overrides Timed<D, Error>.constructor
- Defined in cmds/cmds-step.ts:14

Properties

`Optional` description

description?: string

`Optional` ended

ended?: number | false = false

`Optional` failed

failed?: Error

impl

impl: StepFn<C, D>

log

log: Core.Console = ...

name

name: string = impl.name

`Optional` result

result?: D

`Optional` started

started?: number | false = false

Accessors

took

get took(): string
Returns string
Inherited from Timed.took
- Defined in time/time.ts:14

Methods

call

call(context, ...args): Promise<D>
- Always async.
- Bind "this" in impl.
Parameters
- context: C
- Rest ...args: any[]
Returns Promise<D>
updated copy of context.
- Defined in cmds/cmds-step.ts:27

`Protected` end

end(): number
Returns number
Inherited from Timed.end
- Defined in time/time.ts:23

`Protected` fail

fail(failed): number
Parameters
- failed: Error
Returns number
Inherited from Timed.fail
- Defined in time/time.ts:33

`Protected` start

start(): number
Returns number
Inherited from Timed.start
- Defined in time/time.ts:19

`Protected` succeed

succeed(result): number
Parameters
- result: D
Returns number
Inherited from Timed.succeed
- Defined in time/time.ts:28

`Static` from

from<C, D>(specifier): Step<C, D>
Type Parameters
- C
- D
Parameters
- specifier: unknown
Returns Step<C, D>
- Defined in cmds/cmds-step.ts:39

Generated using TypeDoc