@fal-works/s-l-t-r
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Interfaces

Type aliases

Variables

Type aliases

CommandSubType

CommandSubType: typeof CommandSubType[keyof typeof CommandSubType]

CommandType

CommandType: typeof CommandType[keyof typeof CommandType]

DisplayState

DisplayState: typeof DisplayState[keyof typeof DisplayState]

Event

Event: typeof Event[keyof typeof Event]

EventHandler

EventHandler: (command: Command, event: Event) => Promise<void> | undefined

Function for handling command events. If it returns a Promise, it overrides the default behavior of command.

Type declaration

    • (command: Command, event: Event): Promise<void> | undefined

    • Parameters

      Returns Promise<void> | undefined

Result

Result: Map<Command, EventRecord[]>

Return value from run().

Variables

Const CommandSubType

CommandSubType: { CommandLine: "commandline"; External: "external"; Null: "null"; Parallel: "parallel"; Sequence: "sequence" } = {CommandLine: "commandline",External: "external",Null: "null",Sequence: "sequence",Parallel: "parallel",} as const

Value that specifies the sub-type of a Command object.

Type declaration

  • CommandLine: "commandline"
  • External: "external"
  • Null: "null"
  • Parallel: "parallel"
  • Sequence: "sequence"

Const CommandType

CommandType: { Group: "group"; Unit: "unit" } = {Unit: "unit",Group: "group",} as const

Value that specifies the type of a Command object.

Type declaration

  • Group: "group"
  • Unit: "unit"

Const DisplayState

DisplayState: { Collapsed: "collapsed"; Hidden: "hidden" } = {Collapsed: "collapsed",Hidden: "hidden",} as const

Type declaration

  • Collapsed: "collapsed"
  • Hidden: "hidden"

Const Event

Event: { Failure: "failure"; Start: "start"; Success: "success" } = {Start: "start",Success: "success",Failure: "failure",} as const

Event fired by Command objects.

Type declaration

  • Failure: "failure"
  • Start: "start"
  • Success: "success"

Legend

Generated using TypeDoc