Class ConsoleService

Hierarchy

ConsoleService

Index

Constructors

Properties

cli commands container? responseListener

Methods

createCommand createGroupCommand getCli getCommandFullName getContainer getRootCli init resetCli setContainer createCli createHandler

Constructors

constructor

new ConsoleService(cli): ConsoleService
Parameters
- cli: Command
Returns ConsoleService
- Defined in service.ts:31

Properties

`Protected` cli

cli: Command

The root cli

`Protected` commands

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

A Map holding group commands by name

`Protected` `Optional` container

container?: INestApplicationContext

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

`Protected` responseListener

responseListener: EventEmitter = ...

Methods

createCommand

createCommand(options, handler, parent, commanderOptions?): 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
- Optional commanderOptions: CommandOptions
Returns Command
- Defined in service.ts:127

createGroupCommand

createGroupCommand(options, parent): 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)
- Defined in service.ts:183

getCli

getCli(name?): undefined | Command
Get a cli
Parameters
- Optional name: string
  
  Get a cli by name, if not set, the root cli is used
Returns undefined | Command
- Defined in service.ts:60

getCommandFullName

getCommandFullName(command): string
Get the full name of a command (parents names + command names separated by dot)
Parameters
- command: Command
Returns string
- Defined in service.ts:213

getContainer

getContainer(): undefined | INestApplicationContext
Get the container

Returns undefined | INestApplicationContext
- Defined in service.ts:81

getRootCli

getRootCli(): Command
Get the root cli

Returns Command
- Defined in service.ts:52

init

init(argv): Promise<CommandResponse>
Execute the cli
Parameters
- argv: string[]
Returns Promise<CommandResponse>
- Defined in service.ts:107

resetCli

resetCli(): void
Reset the cli stack (for testing purpose only)

Returns void
- Defined in service.ts:45

setContainer

setContainer(container): ConsoleService
Set the container
Parameters
- container: INestApplicationContext
Returns ConsoleService
- Defined in service.ts:73

`Static` createCli

createCli(name?): Command
Parameters
- Optional name: string
Returns Command
- Defined in service.ts:35

`Static` createHandler

createHandler(action): CommandActionWrapper
Wrap an action handler to work with promise.
Parameters
- action: CommandActionHandler
Returns CommandActionWrapper
- Defined in service.ts:88