UsageDirective

flitter-cli/directives/UsageDirective~ UsageDirective

Directive to display help and usage information

Constructor

new UsageDirective()

Source:

Extends

Methods

(static) help() → {string}

Source:

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

Returns:
Type
string

(static) name() → {string}

Source:

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

Returns:

"help"

Type
string

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

Source:
Overrides:

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

Returns:
Type
Promise.<void>