Class Components

Components repository (singleton)

Hierarchy

Components

Index

Constructors

constructor

Properties

Accessors

instance

Methods

Constructors

Private constructor

new Components(app?: Application): Components

- Defined in packadic/lib/Components.ts:35
Parameters
- Optional app: Application
Returns Components

Properties

Protected app

app: Application

Protected components

components: object

Type declaration

[name: string]: Component

Static Protected COMPONENTS

COMPONENTS: object

Type declaration

[name: string]: IExtensionClass<Component>

Static Private _instance

_instance: Components

Accessors

Static instance

get instance(): Components

- Defined in packadic/lib/Components.ts:57
Get the Components instance

Returns Components

Methods

all

all(): object

- Defined in packadic/lib/Components.ts:115
Returns all loaded components

Returns object
- [name: string]: Component

each

each(fn: ObjectIterator<Component, void>): Components

- Defined in packadic/lib/Components.ts:150
Iterate over all loaded components, executing the callback function each time

Parameters
- fn: ObjectIterator<Component, void>
Returns Components

get

get(name?: string): Component

- Defined in packadic/lib/Components.ts:76
Returns a loaded component

Parameters
- Optional name: string
Returns Component

getRegistered

getRegistered(): object

- Defined in packadic/lib/Components.ts:123
Returns object
- [name: string]: IExtensionClass<Component>

getRegisteredNames

getRegisteredNames(): string[]

- Defined in packadic/lib/Components.ts:119
Returns string[]

has

has(name: string): boolean

- Defined in packadic/lib/Components.ts:67
Returns true if the component is loaded

Parameters
- name: string
Returns boolean

load

load(name: any, cb?: Function): Component

- Defined in packadic/lib/Components.ts:89
Load a registered component

Parameters
- name: any
- Optional cb: Function
Returns Component

loadAll

loadAll(): Components

- Defined in packadic/lib/Components.ts:131
Load all registered components

Returns Components

Static register

register<T>(name: string, componentClass: IExtensionClass<Component>, configToMergeIntoDefaults?: any): void

- Defined in packadic/lib/Components.ts:161
Register a Component with the Components class

Type parameters
- T: IExtension
Parameters
- name: string
- componentClass: IExtensionClass<Component>
- Optional configToMergeIntoDefaults: any
Returns void