Class ComponentGroup

A higher order component to handle a group of children.

Hierarchy

ComponentGroup
- BaseServer

Implements

Component

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ComponentGroup(options: ComponentGroupOptions): ComponentGroup

- Defined in component/ComponentGroup.ts:23
Parameters
- options: ComponentGroupOptions
Returns ComponentGroup

Properties

children

children: Component[]

logger

logger: LoggerInstance

options

options: ComponentGroupOptions

type

type: GROUP

Methods

component

component(component: Component): number

- Defined in component/ComponentGroup.ts:99
Register a new component.

Parameters
- component: Component
Returns number

components

components(): Component[]

- Defined in component/ComponentGroup.ts:92
Gets currently registered components.

Returns Component[]

describe

describe(): ComponentGroupDescription

Implementation of Component.describe
- Defined in component/ComponentGroup.ts:33
Describes current component group.

Returns ComponentGroupDescription

onInit

onInit(server: BaseServer): Promise<void>

Implementation of Component.onInit
- Defined in component/ComponentGroup.ts:62
Handles pre initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onMount

onMount(server: BaseServer): void

Implementation of Component.onMount
- Defined in component/ComponentGroup.ts:52
Handles post mount routines.

Parameters
- server: BaseServer
Returns void

onReady

onReady(server: BaseServer): Promise<void>

Implementation of Component.onReady
- Defined in component/ComponentGroup.ts:72
Handles post initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onUnmount

onUnmount(server: BaseServer): void

Implementation of Component.onUnmount
- Defined in component/ComponentGroup.ts:83
Handles post unmount routines.

Parameters
- server: BaseServer
Returns void

Generated using TypeDoc