ConfigUnit

libflitter/config/ConfigUnit~ ConfigUnit

Unit to load and manage config files.

Constructor

new ConfigUnit(base_directoryopt)

Instantiate the unit.

Parameters:
Name Type Attributes Default Description
base_directory string <optional>
 './config'

the base directory
Source:

Extends

Members

(static) name

Name of the service provided by this unit: 'configs'

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:

canonical_item :string

The canonical name of the item.

Type:
  • string
Overrides:
Source:

canonical_items :object

Mapping of canonical names to instances for this item.

Type:
  • object
Overrides:
Source:

directory :Promise.<void>|Promise.<string>

The root directory for this canonical resource's files.

Type:
  • Promise.<void> | Promise.<string>
Overrides:
Source:

suffix :string

The file extension of the canonical item files.

Type:
  • string
Overrides:
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
Overrides:
Source:
Returns:
Type
Promise.<void>

directories() → {object}

Get the directories provided by this unit.

Overrides:
Source:
Returns:
Type
object

get(name) → {object}

Resolve an unqualified canonical name to a registered canonical item.

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

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

Initialize the unit. Load the dotenv configuration.

Parameters:
Name Type Description
app
Overrides:
Source:
Returns:
Type
Promise.<void>

guarantee(accessor, mergeopt) → {Object}

A helper function that calls module:libflitter/config/ConfigUnit~ConfigUnit#get, but guarantees an object is returned, even if no config is found for the given accessor.

Parameters:
Name Type Attributes Default Description
accessor string

period-delineated access string
merge Object <optional>
 {}

default values to override
Source:
Returns:
Type
Object

(async) init_canonical_file(info) → {Promise.<*>}

Prepare a single canonical item and return the value that should be given by the resolver.

Parameters:
Name Type Description
info object
Properties
Name Type Description
app module:libflitter/app/FlitterApp
name string

the unqualified canonical name
instance *

the exports from the file
Overrides:
Source:
Returns:
Type
Promise.<*>

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.

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

templates() → {Object}

Get the templates provided by this unit. Currently, "config" provided by module:libflitter/templates/config

Source:
Returns:
Type
Object