Class CommandLine

Service for managing directives, templates, and other resources related to the command line utilities.

Hierarchy

Unit
- CommandLine

Index

Constructors

Properties

directives logging status templates

Accessors

appClassApplication

Methods

app container down getASCIILogo getBoundMethod getDirectives getTemplate getTemplates hasDirective hasTemplate isCLI make registerDirective registerTemplate up

Constructors

constructor

new CommandLine(): CommandLine
Returns CommandLine
Overrides Unit.constructor
- Defined in src/cli/service/CommandLine.ts:30

Properties

`Protected` directives

directives: Collection<Instantiable<Directive>> = ...

Directive classes registered with the CLI command.

`Protected` `Readonly` logging

logging: Logging

status

status: UnitStatus = UnitStatus.Stopped

The current status of the unit.

`Protected` templates

templates: Collection<Template> = ...

Templates registered with the CLI command. These can be created with the TemplateDirective.

Accessors

`Private` appClassApplication

get appClassApplication(): Application
The global application instance.

Returns Application
Inherited from Unit.appClassApplication
- Defined in src/lifecycle/AppClass.ts:31

Methods

`Protected` app

app(): Application
Get the global Application.

Returns Application
Inherited from Unit.app
- Defined in src/lifecycle/AppClass.ts:36

`Protected` container

container(): Container
Get the global Container.

Returns Container
Inherited from Unit.container
- Defined in src/lifecycle/AppClass.ts:41

down

down(): void | Promise<void>
This method is called to stop the unit when the application is shutting down. Here, you should do any teardown required to stop the package cleanly.

IN PARTICULAR take care to free blocking resources that could prevent the process from exiting without a kill.

Returns void | Promise<void>
Inherited from Unit.down
- Defined in src/lifecycle/Unit.ts:35

getASCIILogo

getASCIILogo(): string
Returns a string containing the Extollo ASCII logo.

Returns string
- Defined in src/cli/service/CommandLine.ts:53

getBoundMethod

getBoundMethod(methodName: string): ((...args: any[]) => any)
Get the method with the given name from this class, bound to this class.

Returns
function
Parameters
- methodName: string
Returns ((...args: any[]) => any)
- - (...args: any[]): any
  - Get the method with the given name from this class, bound to this class.
    
    Returns
    function
    Parameters
    - Rest ...args: any[]
    Returns any
Inherited from Unit.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55

getDirectives

getDirectives(): Collection<Instantiable<Directive>>
Get a collection of all registered directives.

Returns Collection<Instantiable<Directive>>
- Defined in src/cli/service/CommandLine.ts:88

getTemplate

getTemplate(name: string): undefined | Template
Returns the template with the given name, if one exists.
Parameters
- name: string
Returns undefined | Template
- Defined in src/cli/service/CommandLine.ts:120

getTemplates

getTemplates(): Collection<Template>
Get a collection of all registered templates.

Returns Collection<Template>
- Defined in src/cli/service/CommandLine.ts:127

hasDirective

hasDirective(directiveClass: Instantiable<Directive>): boolean
Returns true if the given directive is registered with this service.
Parameters
- directiveClass: Instantiable<Directive>
Returns boolean
- Defined in src/cli/service/CommandLine.ts:81

hasTemplate

hasTemplate(name: string): boolean
Returns true if a template with the given name exists.
Parameters
- name: string
Returns boolean
- Defined in src/cli/service/CommandLine.ts:112

isCLI

isCLI(): boolean
Returns true if the application was started from the command line.

Returns boolean
- Defined in src/cli/service/CommandLine.ts:46

`Protected` make

make<T>(target: any, ...parameters: any[]): T
Call the make() method on the global container.
Type Parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T
Inherited from Unit.make
- Defined in src/lifecycle/AppClass.ts:46

registerDirective

registerDirective(directiveClass: Instantiable<Directive>): CommandLine
Register a Directive class with this service. This will make the directive available for use on the CLI.
Parameters
- directiveClass: Instantiable<Directive>
Returns CommandLine
- Defined in src/cli/service/CommandLine.ts:69

registerTemplate

registerTemplate(template: Template): CommandLine
Register the given template with this service. This makes the template available for use with the TemplateDirective service.
Parameters
- template: Template
Returns CommandLine
- Defined in src/cli/service/CommandLine.ts:97

up

up(): Promise<void>
This method is called to start the unit when the application is booting. Here, you should do any setup required to get the package up and running.

Returns Promise<void>
Overrides Unit.up
- Defined in src/cli/service/CommandLine.ts:34