Class BootstrapConsole

A class to boot a nestjs application context from cli

Hierarchy (View Summary)

AbstractBootstrapConsole<INestApplicationContext, CommonBootstrapConsoleOptions>
- BootstrapConsole

Index

Constructors

Properties

container options service

Methods

boot create getOptions getService init useDecorators

Constructors

constructor

new BootstrapConsole(options: CommonBootstrapConsoleOptions): BootstrapConsole
Parameters
- options: CommonBootstrapConsoleOptions
Returns BootstrapConsole
Inherited from AbstractBootstrapConsole.constructor
- Defined in bootstrap/abstract.ts:62

Properties

`Protected`container

container: INestApplicationContext

The application container

`Protected` `Readonly`options

options: CommonBootstrapConsoleOptions

The options to bootstrap

`Protected`service

service: ConsoleService

The console service

Methods

boot

boot(argv?: string[]): Promise<CommandResponse<any>>
Boot the console
Parameters
- argv: string[] = process.argv
  The list of arguments to pass to the cli, default are process.argv
Returns Promise<CommandResponse<any>>
Inherited from AbstractBootstrapConsole.boot
- Defined in bootstrap/abstract.ts:113

create

create(): Promise<INestApplicationContext>
An abstract method to create the nest application instance. Could return any kind of NestApplication (headless or not)

Returns Promise<INestApplicationContext>
Overrides AbstractBootstrapConsole.create
- Defined in bootstrap/console.ts:13

getOptions

getOptions(): CommonBootstrapConsoleOptions
Get the options

Returns CommonBootstrapConsoleOptions
Inherited from AbstractBootstrapConsole.getOptions
- Defined in bootstrap/abstract.ts:105

getService

getService(): ConsoleService
Get the console service

Returns ConsoleService
Inherited from AbstractBootstrapConsole.getService
- Defined in bootstrap/abstract.ts:98

init

init(): Promise<INestApplicationContext>
Init the console application

Returns Promise<INestApplicationContext>
Inherited from AbstractBootstrapConsole.init
- Defined in bootstrap/abstract.ts:85

`Protected`useDecorators

useDecorators(): Promise<BootstrapConsole>
Activate the decorators scanner

Returns Promise<BootstrapConsole>
Inherited from AbstractBootstrapConsole.useDecorators
- Defined in bootstrap/abstract.ts:76