Class Command

An executable command that can be added to a terminal's command list.

Index

Constructors

Accessors

key action manual

Methods

Constructors

constructor

new Command(
    key: string,
    action: (
        args: (string | number | boolean)[],
        options: Options,
        terminal: Terminal,
    ) => any,
): Command
Parameters
- key: string
  the key used to identify the command
- action: (
      args: (string | number | boolean)[],
      options: Options,
      terminal: Terminal,
  ) => any
  the function to execute when the command is run
Returns Command
- Defined in src/commands.ts:133

Accessors

key

get key(): string
Get the key used to identify the command.

Returns string
- Defined in src/commands.ts:103

action

get action(): (
    args: (string | number | boolean)[],
    options: Options,
    terminal: Terminal,
) => {}
Get the function to execute when the command is run.

Returns (
    args: (string | number | boolean)[],
    options: Options,
    terminal: Terminal,
) => {}
- Defined in src/commands.ts:109

manual

get manual(): undefined | string
Get the manual for the command.

Returns undefined | string
- Defined in src/commands.ts:115
set manual(manual: string): void
Set the manual for the command.
Parameters
- manual: string
  the manual for the command
Returns void
- Defined in src/commands.ts:121

Methods

parseInput

parseInput(userInput: string[]): ArgsOptions
Parses an input array into an ArgsOptions object.
Parameters
- userInput: string[]
  the input array to parse
Returns ArgsOptions
the parsed input
- Defined in src/commands.ts:143

run

run(userInput: string[], rawInput: string, term: Terminal): ExitObject
Runs the command with the given input.
Parameters
- userInput: string[]
  the input array to parse
- rawInput: string
  the raw input that was used to execute the command
- term: Terminal
  the terminal to run the command in
Returns ExitObject
the ExitObject the command returns
- Defined in src/commands.ts:154