ExpressUnit

libflitter/express/ExpressUnit~ ExpressUnit

The Express unit is responsible for injecting the 3rd-party tools that Flitter makes available into the underlying Express framework so they can be used in lower contexts. Currently, that includes the body parser and session store.

Constructor

new ExpressUnit()

Source:

Extends

Members

(static) name

Gets the name of the service provided by this unit: 'express'

Source:

(static) services

Defines the services required by this unit.

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>}

Closes the session store's DB connection.

Parameters:
Name Type Description
app module:libflitter/app/FlitterApp~FlitterApp
Overrides:
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.

Inherited From:
Source:
Returns:
Type
Object

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

Loads the unit. Registers the 'busboy-body-parser' and 'express-session' packages with the underlying Express app.

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

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

migrations() → {string}

Get the fully-qualified path to the migrations provided by this unit.

Source:
Returns:
Type
string

name() → {String}

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

Inherited From:
Source:
Returns:
Type
String

(async) ssl_certificate() → {Promise.<(string|undefined)>}

Gets the contents of the configured SSL certificate.

Source:
Returns:
Type
Promise.<(string|undefined)>

(async) ssl_key() → {Promise.<(string|undefined)>}

Gets the contents of the configured SSL key.

Source:
Returns:
Type
Promise.<(string|undefined)>

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
Inherited From:
Source:
Returns:
  • current status of the unit
Type
string

use_ssl() → {boolean}

If true, the application has been provided an SSL certificate and key.

Source:
Returns:
Type
boolean