Canonical | The Extollo Framework

Abstract unit type that loads items recursively from a directory structure, assigning them normalized names ("canonical names"), and providing a way to fetch the resources by name.

example

The Config service is a Canonical derivative that loads files ending with .config.js from the app/config directory.

If, for example, there is a config file app/config/auth/Forms.config.js (in the generated code), it can be loaded by the canonical name auth:Forms.

Type parameters

Hierarchy

Unit
- Canonical

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Canonical<T>(): Canonical<T>

Inherited from Unit.constructor

Type parameters
- T
Returns Canonical<T>

Properties

Protected appPath

appPath: string[] = []

The base path directory where the canonical definitions reside.

Protected Readonly canon

canon: Canon

Protected canonicalItem

canonicalItem: string = ''

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

example: middleware

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

status

status: UnitStatus = ...

The current status of the unit.

Protected suffix

suffix: string = '.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[]

- 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 Unit.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Protected buildCanonicalDefinition

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

- 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 Unit.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

down

down(): void | Promise<void>

Inherited from Unit.down
- Defined in src/lifecycle/Unit.ts:35
This method is called to stop the unit when the application is shutting down. Here, you should do any teardown required to stop the package cleanly.

IN PARTICULAR take care to free blocking resources that could prevent the process from exiting without a kill.

Returns void | Promise<void>

get

get(key: string): undefined | T

- Defined in src/service/Canonical.ts:159
Get a canonical item by key.

Parameters
- key: string
Returns undefined | T

getBoundMethod

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

Inherited from Unit.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<T>

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

Protected make

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

Inherited from Unit.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[]

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

Returns string[]

registerNamespace

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

- 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<T>
Returns void

up

up(): Promise<void>

Overrides Unit.up
- Defined in src/service/Canonical.ts:223
Returns Promise<void>

Static resolve

resolve(reference: string): CanonicalReference

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

Parameters
- reference: string
Returns CanonicalReference

CanonicalReference

Type parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T

Returns Canonical<T>

Properties

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

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 void | Promise<void>

get

Parameters

key: string

Returns undefined | T

getBoundMethod

Parameters

methodName: string

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

Parameters

Rest ...args: any[]

Returns any

initCanonicalItem

Parameters

definition: CanonicalDefinition

Returns Promise<T>

Protected make

Type parameters

T

Parameters

target: any

Rest ...parameters: any[]

Returns T

namespaces

Returns string[]

registerNamespace

Parameters

name: string

resolver: CanonicalResolver<T>

Returns void

up

Returns Promise<void>