UsageDirective

flitter-cli/directives/UsageDirective~ UsageDirective

Directive to display help and usage information

Constructor

new UsageDirective()

Source:

Extends

Members

(private) _di_allow_defer :boolean

If true, the injector will defer the class if the class requests any services that the container is missing. These services are filled in later and added to the prototype and any instances. True by default.

Type:
  • boolean
Inherited From:
Source:

(private) _di_deferred_instances :Array.<module:flitter-di/src/Injectable~Injectable>

Collection of instances of this class that need to have the deferred service instances injected into them when the deferred services are finally provided.

Type:
Inherited From:
Source:

(private) _di_deferred_services :Array.<string>

List of services that were deferred and not provided at the time of injection.

Type:
  • Array.<string>
Inherited From:
Source:

(private) _options :Object

Mapping of option names to option values for the current invocation.

Type:
  • Object
Inherited From:
Source:

Methods

(static) help() → {string}

Get the usage information for the directive. Used by ./flitter help.

Source:
Returns:
Type
string

(static) name() → {string}

Get the name of the directive. Used by ./flitter.

Source:
Returns:

"help"

Type
string

error(message)

Outputs an [ERROR] message to the console.

Parameters:
Name Type Description
message string
Inherited From:
Source:

(async) handle(app, argv) → {Promise.<void>}

Handle an invocation of the Directive. Prints the usage information for all registered instances of module:flitter-cli/Directive~Directive.

Parameters:
Name Type Description
app module:libflitter/app/FlitterApp~FlitterApp

the Flitter app
argv Array

the CLI arguments passed to the directive
Overrides:
Source:
Returns:
Type
Promise.<void>

info(message)

Outputs an [INFO] message to the console.

Parameters:
Name Type Description
message string
Inherited From:
Source:

option(name) → {string}

Gets the value of the option with the specified name for the current invocation.

Parameters:
Name Type Description
name string
Inherited From:
Source:
Returns:
Type
string

success(message)

Outputs a [SUCCESS] message to the console.

Parameters:
Name Type Description
message string
Inherited From:
Source:

warning(message)

Outputs a [WARNING] message to the console.

Parameters:
Name Type Description
message string
Inherited From:
Source: