Unit

libflitter/Unit~ Unit

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

Constructor

new Unit()

Source:

Methods

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

Source:

Cleans up the unit's resources before Flitter closes.

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

the Flitter app

Returns:
Type
Promise.<void>

directories() → {Object}

Source:

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.

Returns:
Type
Object

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

Source:

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.

Returns:
Type
Promise.<void>

name() → {String}

Source:

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

Returns:
Type
String