Unit

libflitter/Unit~ Unit

Base class for all Flitter Units. A Unit provides one piece of functionality in Flitter.

Constructor

new Unit()

Source:

Extends

Members

(static) provides

Names of additional services provided by this unit.

Source:

(static) services

Defines the services required by this unit. The 'app' service is provided 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
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:

Methods

(async) cleanup(app) → {Promise.<void>}

Cleans up the unit's resources before Flitter closes.

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

the Flitter app
Source:
Returns:
Type
Promise.<void>

directories() → {Object}

Get the directories provided by the unit. Should be an object such that key => value is the name of the directory => fully qualified path to the directory.

Source:
Returns:
Type
Object

(async) go(app, context) → {Promise.<void>}

Loads the unit. This should attach the unit's functionality to the Flitter app. It is provided a context where its variables and methods that need to be made available to the rest of the app should reside.

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

the Flitter app
context module:libflitter/Context~Context

the unit's context. This is where variables and methods provided by the unit should be bound.
Source:
Returns:
Type
Promise.<void>

name() → {String}

Get the name of the unit. Should be a lowercase, alphanum/dash/underscore string.

Source:
Returns:
Type
String

status(setopt) → {string}

Get or set the unit's current status.

Parameters:
Name Type Attributes Description
set string <optional>

if provided, set the status of the unit
Source:
Returns:
  • current status of the unit
Type
string