Config | The Extollo Framework

Canonical unit that loads configuration files from app/configs.

Hierarchy

CanonicalRecursive
- Config

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Config(): Config

Inherited from CanonicalRecursive.constructor

Returns Config

Properties

Protected accessedKeys

accessedKeys: string[] = []

Array of all unique accessed config keys, if recordConfigAccesses is true.

Protected appPath

appPath: string[] = ...

The base path directory where the canonical definitions reside.

Protected Readonly canon

canon: Canon

Protected canonicalItem

canonicalItem: string = 'config'

The singular, programmatic name of one of these canonical items.

Protected loadedItems

loadedItems: {} = {}

Object mapping canonical names to loaded file references.

Type declaration

[key: string]: T

Protected loadedNamespaces

loadedNamespaces: {} = {}

Object mapping canonical namespaces to resolver functions.

Type declaration

[key: string]: CanonicalResolver<T>

Protected Readonly logging

logging: Logging

Protected recordConfigAccesses

recordConfigAccesses: boolean = false

If true, all the unique configuration keys will be stored for debugging.

status

status: UnitStatus = ...

The current status of the unit.

Protected suffix

suffix: string = '.config.js'

The file suffix of files in the base path that should be loaded.

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

canonicalItems

get canonicalItems(): string

- Defined in src/service/Canonical.ts:154
Get the plural name of the canonical items provided by this unit.

Returns string

path

get path(): UniversalPath

- Defined in src/service/Canonical.ts:149
Get a Universal path to the base directory where this unit loads its canonical files from.

Returns UniversalPath

Methods

all

all(namespace?: string): string[]

Inherited from CanonicalRecursive.all
- Defined in src/service/Canonical.ts:119
Return an array of all loaded canonical names.

Parameters
- Optional namespace: string
Returns string[]

Protected app

app(): Application

Inherited from CanonicalRecursive.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected buildCanonicalDefinition

buildCanonicalDefinition(filePath: string, basePath?: UniversalPath): Promise<CanonicalDefinition>

Inherited from CanonicalRecursive.buildCanonicalDefinition
- Defined in src/service/Canonical.ts:262
Given the path to a file in the canonical items directory, create a CanonicalDefinition record from that file.

Parameters
- filePath: string
- Optional basePath: UniversalPath
Returns Promise<CanonicalDefinition>

Protected container

container(): Container

Inherited from CanonicalRecursive.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

down

down(): Promise<void>

Overrides CanonicalRecursive.down
- Defined in src/service/Config.ts:34
Returns Promise<void>

get

get(key: string, fallback?: unknown): any

Overrides CanonicalRecursive.get
- Defined in src/service/Config.ts:43
Parameters
- key: string
- Optional fallback: unknown
Returns any

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from CanonicalRecursive.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

initCanonicalItem

initCanonicalItem(definition: CanonicalDefinition): Promise<any>

Inherited from CanonicalRecursive.initCanonicalItem
- Defined in src/service/Canonical.ts:252
Called for each canonical item loaded from a file. This function should do any setup necessary and return the item that should be associated with the canonical name.

Parameters
- definition: CanonicalDefinition
Returns Promise<any>

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from CanonicalRecursive.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

namespaces

namespaces(): string[]

Inherited from CanonicalRecursive.namespaces
- Defined in src/service/Canonical.ts:142
Return an array of all loaded canonical namespaces.

Returns string[]

registerNamespace

registerNamespace(name: string, resolver: CanonicalResolver<any>): void

Inherited from CanonicalRecursive.registerNamespace
- Defined in src/service/Canonical.ts:211
Register a namespace resolver with the canonical unit.

Namespaces are canonical names that start with a particular key, beginning with the @ character, which resolve their resources using a resolver function.
example
```
const items = {
    'foo:bar': 123,
    'bob': 456,
}

const resolver = (key: string) => items[key]

canonical.registerNamespace('@mynamespace', resolver)
```
Now, the items in the @mynamespace namespace can be accessed like so:
```
canonical.get('@mynamespace:foo:bar')  // => 123
canonical.get('@mynamespace:bob')  // => 456
```
Parameters
- name: string
- resolver: CanonicalResolver<any>
Returns void

up

up(): Promise<void>

Overrides CanonicalRecursive.up
- Defined in src/service/Config.ts:25
Returns Promise<void>

Static resolve

resolve(reference: string): CanonicalReference

Inherited from CanonicalRecursive.resolve
- Defined in src/service/Canonical.ts:101
Resolve a canonical reference from its string form to a CanonicalReference.

Parameters
- reference: string
Returns CanonicalReference

CanonicalReference

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Config

Properties

Protected accessedKeys

Protected appPath

Protected Readonly canon

Protected canonicalItem

Protected loadedItems

Type declaration

[key: string]: T

Protected loadedNamespaces

Type declaration

[key: string]: CanonicalResolver<T>

Protected Readonly logging

Protected recordConfigAccesses

status

Protected suffix

Accessors

Private appClassApplication

Returns Application

canonicalItems

Returns string

path

Returns UniversalPath

Methods

all

Parameters

Optional namespace: string

Returns string[]

Protected app

Returns Application

Protected buildCanonicalDefinition

Parameters

filePath: string

Optional basePath: UniversalPath

Returns Promise<CanonicalDefinition>

Protected container

Returns Container

down

Returns Promise<void>

get

Parameters

key: string

Optional fallback: unknown

Returns any

getBoundMethod

Parameters

methodName: string

Returns (...args: any[]) => any

Parameters

Rest ...args: any[]

Returns any

initCanonicalItem

Parameters

definition: CanonicalDefinition

Returns Promise<any>

Protected make

Type parameters

T

Parameters

target: any

Rest ...parameters: any[]

Returns T

namespaces

Returns string[]

registerNamespace

Parameters

name: string

resolver: CanonicalResolver<any>

Returns void

up

Returns Promise<void>

Static resolve