Directive

flitter-cli/Directive~ Directive

Base class for ./flitter directives.

Constructor

new Directive(option_values)

Instantiate the directive

Parameters:
Name Type Description
option_values object

mapping of option names to option values
Source:

Extends

Members

(static) services

Defines the services required by this directive. Includes the 'cli' and 'output' services by default.

Source:

(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
Overrides:
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:
Overrides:
Source:

(private) _di_deferred_services :Array.<string>

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

Type:
  • Array.<string>
Overrides:
Source:

(private) _options :Object

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

Type:
  • Object
Source:

Methods

(static) help() → {string}

Get the usage information of the directive. This is displayed on the ./flitter help page.

Source:
Returns:
Type
string

(static) name() → {string}

Get the name of the directive. This is used by ./flitter to run this directive.

Source:
Returns:
Type
string

(static) options() → {Array.<module:flitter-cli/options/Option~Option>}

Get an array of the options supported by this directive.

Source:
Returns:
Type
Array.<module:flitter-cli/options/Option~Option>

error(message)

Outputs an [ERROR] message to the console.

Parameters:
Name Type Description
message string
Source:

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

Handle an invocation of this directive.

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

the Flitter app
argv Array.<string>

CLI arguments after the directive
Source:
Returns:
Type
Promise.<void>

info(message)

Outputs an [INFO] message to the console.

Parameters:
Name Type Description
message string
Source:

option(name) → {string}

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

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

success(message)

Outputs a [SUCCESS] message to the console.

Parameters:
Name Type Description
message string
Source:

warning(message)

Outputs a [WARNING] message to the console.

Parameters:
Name Type Description
message string
Source: