Class ReplServerCommand<T>

constructor

• new ReplServerCommand<T extends ReplServerCommandArgs>(
      validator: Validator,
      spec: ReplServerCommandSpec,
      help: ReplServerCommandHelp,
      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.

  • help: ReplServerCommandHelp

    The help function.

  • action: ReplServerCommandAction<T>

    The action function.

  Returns ReplServerCommand<T>

Readonlyspec

execute

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

  Executes command with arguments.

  Parameters

  • console: Console

    The underlying Console instance.

  • args: ReplServerCommandArgs

    The parsed command args.

  • context: ReplServerCommandContext

  Returns Promise<void>

  Throws

  ReplServerError If validation fails.

parseArgs

• parseArgs(args: string): ReplServerCommandArgs

  Parses command arguments with yargs-parser.

  Parameters

  • args: string

    The raw string.

  Returns ReplServerCommandArgs

  Parsed command args.

showHelp

• showHelp(console: Console, detail?: boolean): void

  Shows command help screen.

  Parameters

  • console: Console

    The underlying Console instance.

  • detail: boolean = false

  Returns void