Class ReplServerCommand<T>

constructor

• new ReplServerCommand<T extends ReplServerCommandArgs>(
      validator: Validator,
      spec: ReplServerCommandSpec,
      action: ReplServerCommandAction<T>,
  ): ReplServerCommand<T>

  Creates a new command instance.

  Type Parameters

  • T extends ReplServerCommandArgs

  Parameters

  • validator: Validator

    The validator instance.

  • spec: ReplServerCommandSpec

    The spec object.

  • action: ReplServerCommandAction<T>

    The action function.

  Returns ReplServerCommand<T>

Readonlyspec

checkHelp

• checkHelp(args: ReplServerCommandArgs): boolean

  Checks that need to show help.

  Parameters

  • args: ReplServerCommandArgs

    The parsed command args.

  Returns boolean

  true if help need to show, false otherwise.

execute

• execute(console: Console, args: ReplServerCommandArgs): Promise<void>

  Executes command with arguments.

  Parameters

  • console: Console

    The underlying Console instance.

  • args: ReplServerCommandArgs

    The parsed command args.

  Returns Promise<void>

  Throws

  ReplServerError If validation fails.

parseArgs

• parseArgs(args: string): ReplServerCommandArgs | null

  Parses command arguments with yargs-parser.

  Parameters

  • args: string

    The raw string.

  Returns ReplServerCommandArgs | null

  Parsed command arguments, or null if parsing fails.

showHelp

• showHelp(console: Console): void

  Shows command help screen.

  Parameters

  • console: Console

    The underlying Console instance.

  Returns void