Class CoreBundleModule<K, T, P, C, E>`Abstract`

An abstract base class for modules that need to perform bundle‑level initialization within the kernel. It extends CoreKernelModule and supplies a standard constructor that assigns the module name and kernel reference while also setting the module’s trigger handler to the initBundleModule method.

Type Parameters

K extends ICoreKernel<any>
A concrete type that implements ICoreKernel with any argument.
T extends IDataBase<any, any> | null
Either a concrete IDataBase implementation or {@code null}.
P extends CoreClient | null
Either a concrete CoreClient implementation or {@code null}.
C extends ICoreCache | null
Either a concrete ICoreCache implementation or {@code null}.
E extends ICorePresenter<any> | null
Either a concrete ICorePresenter implementation or {@code null}.

Hierarchy (View Summary)

CoreKernelModule<K, T, P, C, E>
- CoreBundleModule

Constructors

`Protected`constructor

new CoreBundleModule<
    K extends ICoreKernel<any, ICoreAnyModule>,
    T extends

            | IDataBase<
                any,
                any,
                ICoreKernel<any, ICoreAnyModule>,
                any,
                any,
                any,
                any,
            >
            | null,
    P extends
        CoreClient<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
        | null,
    C extends
        ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
        | null,
    E extends
        | ICorePresenter<
            any,
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >
        | null,
>(
    name: string,
    kernel: K,
): CoreBundleModule<K, T, P, C, E>
Type Parameters
- K extends ICoreKernel<any, ICoreAnyModule>
  A concrete type that implements ICoreKernel with any argument.
- T extends IDataBase<any, any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null
  Either a concrete IDataBase implementation or {@code null}.
- P extends CoreClient<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null
  Either a concrete CoreClient implementation or {@code null}.
- C extends ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null
  Either a concrete ICoreCache implementation or {@code null}.
- E extends ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null
  Either a concrete ICorePresenter implementation or {@code null}.
Parameters
- name: string
- kernel: K
Returns CoreBundleModule<K, T, P, C, E>
Overrides CoreKernelModule.constructor
- Defined in classes/CoreBundleModule.ts:31

Properties

`Protected`channel

channel: string

logger

logger: CoreLogger | null

`Protected` `Optional`trigger

trigger?: () => Promise<void>

Optional trigger function to be executed during registration.

Methods

addAction

addAction(
    ...action: CoreAction<
        ICoreKernel<any, ICoreAnyModule>,
        any,
        any,
        any,
        any,
    >[],
): void
Adds one or more actions to the module.
Parameters
- ...action: CoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
  Actions to add
Returns void
Inherited from CoreKernelModule.addAction
- Defined in classes/CoreKernelModule.ts:378

addService

addService(
    ...service: CoreService<
        ICoreKernel<any, ICoreAnyModule>,
        any,
        any,
        any,
        any,
    >[],
): void
Adds one or more services to the module.
Parameters
- ...service: CoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
  Services to add
Returns void
Inherited from CoreKernelModule.addService
- Defined in classes/CoreKernelModule.ts:388

addSrcBridge

addSrcBridge(bridge: ICoreBridge): void
Adds a source bridge.
Parameters
- bridge: ICoreBridge
  The bridge to add
Returns void
Inherited from CoreKernelModule.addSrcBridge
- Defined in classes/CoreKernelModule.ts:194

addTarBridge

addTarBridge(bridge: ICoreBridge): void
Adds a target bridge.
Parameters
- bridge: ICoreBridge
  The bridge to add
Returns void
Inherited from CoreKernelModule.addTarBridge
- Defined in classes/CoreKernelModule.ts:202

beforeServiceStart

beforeServiceStart(): Promise<void>
Hook called before services are started.

Returns Promise<void>
Inherited from CoreKernelModule.beforeServiceStart
- Defined in classes/CoreKernelModule.ts:323

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.debug
- Defined in classes/CoreLogChannel.ts:41

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.error
- Defined in classes/CoreLogChannel.ts:53

final

final(): Promise<void>
Finalization logic for the module.

Returns Promise<void>
Inherited from CoreKernelModule.final
- Defined in classes/CoreKernelModule.ts:478

getActionList

getActionList(): ICoreAction<
    ICoreKernel<any, ICoreAnyModule>,
    any,
    any,
    any,
    any,
>[]
Returns the list of actions.

Returns ICoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Inherited from CoreKernelModule.getActionList
- Defined in classes/CoreKernelModule.ts:158

getBridgeModule

getBridgeModule<M extends ICoreAnyModule>(name: string): M
Returns a bridge module by name.
Type Parameters
- M extends ICoreAnyModule
Parameters
- name: string
  Name of the module
Returns M
The bridge module
Inherited from CoreKernelModule.getBridgeModule
- Defined in classes/CoreKernelModule.ts:465

getBridges

getBridges(): ICoreBridge[]
Returns the list of source bridges.

Returns ICoreBridge[]
Inherited from CoreKernelModule.getBridges
- Defined in classes/CoreKernelModule.ts:456

getCache

getCache(): C
Returns the cache instance.

Returns C
Throws
Error if cache is not set
Inherited from CoreKernelModule.getCache
- Defined in classes/CoreKernelModule.ts:282

getClient

getClient(): P
Returns the client instance.

Returns P
Throws
Error if client is not set
Inherited from CoreKernelModule.getClient
- Defined in classes/CoreKernelModule.ts:263

getDb

getDb(): T
Returns the database instance.

Returns T
Throws
Error if database is not set
Inherited from CoreKernelModule.getDb
- Defined in classes/CoreKernelModule.ts:244

getDependencyList

getDependencyList(): string[]
Returns the list of dependency names.

Returns string[]
Inherited from CoreKernelModule.getDependencyList
- Defined in classes/CoreKernelModule.ts:449

getKernel

getKernel(): K
Returns the kernel instance.

Returns K
Inherited from CoreKernelModule.getKernel
- Defined in classes/CoreKernelModule.ts:435

getLogger

getLogger(): CoreLogger
Returns the logger instance from the kernel.

Returns CoreLogger
Inherited from CoreKernelModule.getLogger
- Defined in classes/CoreKernelModule.ts:485

getName

getName(): string
Returns the name of the module.

Returns string
Inherited from CoreKernelModule.getName
- Defined in classes/CoreKernelModule.ts:442

getPresenter

getPresenter(): E
Returns the presenter instance.

Returns E
Throws
Error if presenter is not set
Inherited from CoreKernelModule.getPresenter
- Defined in classes/CoreKernelModule.ts:225

getServiceList

getServiceList(): ICoreService<
    ICoreKernel<any, ICoreAnyModule>,
    any,
    any,
    any,
    any,
>[]
Returns the list of services.

Returns ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Inherited from CoreKernelModule.getServiceList
- Defined in classes/CoreKernelModule.ts:397

hasCache

hasCache(): boolean
Returns true if a cache is set.

Returns boolean
Inherited from CoreKernelModule.hasCache
- Defined in classes/CoreKernelModule.ts:186

hasClient

hasClient(): boolean
Returns true if a client is set.

Returns boolean
Inherited from CoreKernelModule.hasClient
- Defined in classes/CoreKernelModule.ts:172

hasDb

hasDb(): boolean
Returns true if a database is set.

Returns boolean
Inherited from CoreKernelModule.hasDb
- Defined in classes/CoreKernelModule.ts:165

hasPresenter

hasPresenter(): boolean
Returns true if a presenter is set.

Returns boolean
Inherited from CoreKernelModule.hasPresenter
- Defined in classes/CoreKernelModule.ts:179

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.info
- Defined in classes/CoreLogChannel.ts:47

`Abstract`initBundleModule

initBundleModule(): Promise<void>
Returns Promise<void>
- Defined in classes/CoreBundleModule.ts:36

`Abstract`initModule

initModule(): Promise<void>
Abstract method to initialize the module.

Returns Promise<void>
Inherited from CoreKernelModule.initModule
- Defined in classes/CoreKernelModule.ts:318

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Inherited from CoreKernelModule.lError
- Defined in classes/CoreLogChannel.ts:71

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.log
- Defined in classes/CoreLogChannel.ts:35

notifyBridges

notifyBridges(state: BridgeState): void
Notifies all target bridges of a state change.
Parameters
- state: BridgeState
  The state to set
Returns void
Inherited from CoreKernelModule.notifyBridges
- Defined in classes/CoreKernelModule.ts:311

register

register(action?: string): Promise<void>
Registers the module, actions, and services.
Parameters
- Optionalaction: string
  Optional kernel event to trigger
Returns Promise<void>
Inherited from CoreKernelModule.register
- Defined in classes/CoreKernelModule.ts:331

setCache

setCache(cache: C): void
Sets the cache instance.
Parameters
- cache: C
  The cache to set
Returns void
Inherited from CoreKernelModule.setCache
- Defined in classes/CoreKernelModule.ts:293

setClient

setClient(client: P): void
Sets the client instance.
Parameters
- client: P
  The client to set
Returns void
Inherited from CoreKernelModule.setClient
- Defined in classes/CoreKernelModule.ts:274

setDb

setDb(db: T): void
Sets the database instance.
Parameters
- db: T
  The database to set
Returns void
Inherited from CoreKernelModule.setDb
- Defined in classes/CoreKernelModule.ts:255

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreKernelModule.setLogger
- Defined in classes/CoreLogChannel.ts:31

setPresenter

setPresenter(presenter: E | null): void
Sets the presenter instance.
Parameters
- presenter: E | null
  The presenter to set
Returns void
Inherited from CoreKernelModule.setPresenter
- Defined in classes/CoreKernelModule.ts:236

shutdown

shutdown(): Promise<void>
Shuts down the module and its services.

Returns Promise<void>
Inherited from CoreKernelModule.shutdown
- Defined in classes/CoreKernelModule.ts:358

start

start(): Promise<void>
Starts the presenter and the module.

Returns Promise<void>
Inherited from CoreKernelModule.start
- Defined in classes/CoreKernelModule.ts:216

startService

startService(
    name: string,
): Promise<
    | ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
    | null,
>
Starts a service by name.
Parameters
- name: string
  Name of the service
Returns Promise<
| ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
| null,
>
The started service or null
Inherited from CoreKernelModule.startService
- Defined in classes/CoreKernelModule.ts:422

startup

startup(): Promise<void>
Startup logic for the module.

Returns Promise<void>
Inherited from CoreKernelModule.startup
- Defined in classes/CoreKernelModule.ts:209

stopService

stopService(
    name: string,
): Promise<
    | ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
    | null,
>
Stops a service by name.
Parameters
- name: string
  Name of the service
Returns Promise<
| ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
| null,
>
The stopped service or null
Inherited from CoreKernelModule.stopService
- Defined in classes/CoreKernelModule.ts:406

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.verbose
- Defined in classes/CoreLogChannel.ts:65

waitForBridgeState

waitForBridgeState(state: BridgeState): Promise<void>
Waits for all source bridges to reach a specific state.
Parameters
- state: BridgeState
  The bridge state to wait for
Returns Promise<void>
Inherited from CoreKernelModule.waitForBridgeState
- Defined in classes/CoreKernelModule.ts:301

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreKernelModule.warn
- Defined in classes/CoreLogChannel.ts:59

Class CoreBundleModule<K, T, P, C, E>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns CoreBundleModule<K, T, P, C, E>

Properties

Protectedchannel

logger

Protected Optionaltrigger

Methods

addAction

Parameters

Returns void

addService

Parameters

Returns void

addSrcBridge

Parameters

Returns void

addTarBridge

Parameters

Returns void

beforeServiceStart

Returns Promise<void>

debug

Parameters

Returns void

error

Parameters

Returns void

final

Returns Promise<void>

getActionList

Returns ICoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]

getBridgeModule

Type Parameters

Parameters

Returns M

getBridges

Returns ICoreBridge[]

getCache

Returns C

Throws

getClient

Returns P

Throws

getDb

Returns T

Throws

getDependencyList

Returns string[]

getKernel

Returns K

getLogger

Returns CoreLogger

getName

Returns string

getPresenter

Returns E

Throws

getServiceList

Returns ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]

hasCache

Returns boolean

hasClient

Returns boolean

hasDb

Returns boolean

hasPresenter

Returns boolean

info

Parameters

Returns void

Class CoreBundleModule<K, T, P, C, E>`Abstract`

`Protected`constructor

`Protected`channel

`Protected` `Optional`trigger

`Abstract`initBundleModule

`Abstract`initModule

Returns Promise<
| ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
| null,
>

Returns Promise<
| ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
| null,
>