Class ConsoleService

Constructors

constructor

Properties

cli commands container? responseListener

Methods

createCommand createGroupCommand getCli getCommandFullName getContainer getRootCli init resetCli setContainer createCli createHandler

Constructors

constructor

Properties

Protectedcli

cli: Command

The root cli

Protectedcommands

commands: Map<string, Command> = ...

A Map holding group commands by name

Protected Optionalcontainer

container?: INestApplicationContext

An optional instance of the application. Required to scan the application

ProtectedresponseListener

responseListener: EventEmitter = ...

Methods

createCommand

  • createCommand(
        options: CreateCommandOptions,
        handler: CommandActionHandler,
        parent: Command,
        commanderOptions?: CommandOptions,
    ): Command

    Create a Command

    Parameters

    • options: CreateCommandOptions

      The options to create the commands

    • handler: CommandActionHandler

      The handler of the command

    • parent: Command

      The command to use as a parent

    • OptionalcommanderOptions: CommandOptions

    Returns Command

createGroupCommand

  • createGroupCommand(options: CreateCommandOptions, parent: Command): Command

    Create a group of command.

    Parameters

    • options: CreateCommandOptions

      The options to create the grouped command

    • parent: Command

      The command to use as a parent

    Returns Command

    Throws

    an error if the parent command contains explicit arguments, only simple commands are allowed (no spaces)

getCli

  • getCli(name?: string): undefined | Command

    Get a cli

    Parameters

    • Optionalname: string

      Get a cli by name, if not set, the root cli is used

    Returns undefined | Command

getCommandFullName

  • getCommandFullName(command: Command): string

    Get the full name of a command (parents names + command names separated by dot)

    Parameters

    • command: Command

    Returns string

getContainer

  • getContainer(): undefined | INestApplicationContext

    Get the container

    Returns undefined | INestApplicationContext

getRootCli

  • getRootCli(): Command

    Get the root cli

    Returns Command

init

  • init<D = any>(argv: string[]): Promise<CommandResponse<D>>

    Execute the cli

    Type Parameters

    • D = any

    Parameters

    • argv: string[]

    Returns Promise<CommandResponse<D>>

resetCli

  • resetCli(): void

    Reset the cli stack (for testing purpose only)

    Returns void

setContainer

StaticcreateCli

  • createCli(name?: string): Command

    Parameters

    • Optionalname: string

    Returns Command

StaticcreateHandler

  • createHandler(action: CommandActionHandler): CommandActionWrapper

    Wrap an action handler to work with promise.

    Parameters

    • action: CommandActionHandler

    Returns CommandActionWrapper

Settings

Member Visibility

On This Page

Constructors
Properties
Methods