Class Command2<C>

A command is a binding between a string and one or more steps that operate sequentially on the same context.

Type Parameters

  • C extends object

Hierarchy (view full)

Constructors

constructor

Properties

args ended? failed? info log name result? started? steps

Accessors

longestName took

Methods

after end fail run start succeed

Constructors

constructor

Properties

args

args: string

Optional ended

ended?: number | false = false

Optional failed

failed?: Error

info

info: string

log

log: Core.Console

name

name: string

Optional result

result?: C

Optional started

started?: number | false = false

steps

steps: Step<C, unknown>[]

Accessors

longestName

  • get longestName(): number

  • Returns number

took

  • get took(): string

  • Returns string

Methods

after

  • after(): void

  • Returns void

Protected end

  • end(): number

  • Returns number

Protected fail

  • fail(failed): number

  • Parameters

    • failed: Error

    Returns number

run

  • run(args?, context?): Promise<unknown>

  • Run the command with the specified arguments.

    Parameters

    • args: string[] = ...
    • context: any = ...

    Returns Promise<unknown>

Protected start

  • start(): number

  • Returns number

Protected succeed

  • succeed(result): number

  • Parameters

    • result: C

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc