Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseCommand

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Abstract command

command: CommanderDefs

logger

logger: LoggerInstance

options

options: BaseCommandOptions

Methods

getDistributionPath

  • getDistributionPath(): Promise<string>

  • Gets the distribution path registered in the tsconfig.json file.

    Returns Promise<string>

getEntrypoint

  • getEntrypoint(__namedParameters: object): Promise<string>

  • Parameters

    • __namedParameters: object
      • entrypoint: any
      • env: any

    Returns Promise<string>

Protected load

  • load(relativePath: string, options?: ServerOptions): Promise<Server>

  • Loads a new module from its relative path to cwd and initialize its instance.

    Parameters

    • relativePath: string
    • Optional options: ServerOptions

    Returns Promise<Server>

onProgram

  • onProgram(yargs: Argv): Promise<any>

  • Handles Yargs instance registration.

    Parameters

    • yargs: Argv

    Returns Promise<any>

Abstract run

  • run(argv: any): Promise<void>

  • Executes the command when asked by the Command Line with the argv object.

    Parameters

    • argv: any

    Returns Promise<void>

Generated using TypeDoc