Class Kernel

Kernel

Hierarchy (View Summary)

CoreKernel<ICClient>
- Kernel

Implements

IKernel

Constructors

constructor

new Kernel(
    options: {
        appCode: string;
        appName: string;
        folderCreateSkip?: boolean;
        logger?: (kernel: CoreKernel<any>) => CoreLogger;
        overrideGlobalConsoleLog?: boolean;
    } & Omit<EnvStoreCProps, "log" | "appName"> & {
        apiVersion?: number;
        portOverride?: number;
    },
): Kernel
Default Constructor
Parameters
- options: {
      appCode: string;
      appName: string;
      folderCreateSkip?: boolean;
      logger?: (kernel: CoreKernel<any>) => CoreLogger;
      overrideGlobalConsoleLog?: boolean;
  } & Omit<EnvStoreCProps, "log" | "appName"> & {
      apiVersion?: number;
      portOverride?: number;
  }
  App Name
Returns Kernel
Overrides CoreKernel.constructor
- Defined in src/Kernel.ts:22

Properties

`Protected`appCode

appCode: string

`Protected`appName

appName: string

`Protected`appVersion

appVersion: string

`Protected`channel

channel: string

`Protected`coreModule

coreModule: ICoreModule

`Protected`cryptoClient

cryptoClient: ICClient | null

`Protected`devMode

devMode: boolean

`Protected`envStore

envStore: IStore

`Protected`eventMap

eventMap: Map<
string,
(kernel: CoreKernel<ICClient>, payload?: any) => Promise<unknown>,
>

`Protected`extension

extension: CMap<
string,
CoreKernelExtension<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>,
>

`Protected`folderCreateSkip

folderCreateSkip: boolean

`Protected`globalFolderKeys

globalFolderKeys: string[]

`Protected`globalLogger

globalLogger: CoreLogger

`Protected`kernelModule

kernelModule: ICoreAnyModule | null

logger

logger: CoreLogger | null

`Protected`metric

metric: BaseKernelMetric<unknown> | null

`Protected`moduleList

moduleList: ICoreAnyModule[]

`Protected`offline

offline: boolean

`Protected`state

state: any

`Protected`updateSkip

updateSkip: boolean

Methods

addExtension

addExtension(name: string, ext: CoreKernelExtension): void
Parameters
- name: string
  Name of the extension
- ext: CoreKernelExtension
  Extension to add
Returns void

See
CoreKernelExtension
Implementation of IKernel.addExtension

Inherited from CoreKernel.addExtension
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1886

addModule

addModule(...module: ICoreKernelModule<any, any, any, any, any>[]): void
register new module
Parameters
- ...module: ICoreKernelModule<any, any, any, any, any>[]
Returns void

See
CoreKernelModule
Implementation of IKernel.addModule

Inherited from CoreKernel.addModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1880

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.debug

Inherited from CoreKernel.debug
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:221

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.error

Inherited from CoreKernel.error
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:223

getActionList

getActionList(
full?: boolean,
): ICoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Parameters
- Optionalfull: boolean
Returns ICoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Implementation of IKernel.getActionList

Inherited from CoreKernel.getActionList
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1907

getApiVersion

getApiVersion(): number
Returns number
Implementation of IKernel.getApiVersion
- Defined in src/Kernel.ts:57

getAppCode

getAppCode(): string
get app code

Returns string
Implementation of IKernel.getAppCode

Inherited from CoreKernel.getAppCode
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1802

getAppName

getAppName(): string
get app name

Returns string
Implementation of IKernel.getAppName

Inherited from CoreKernel.getAppName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1798

getAppServerPort

getAppServerPort(): number
Returns number
Implementation of IKernel.getAppServerPort
- Defined in src/Kernel.ts:49

getChildModule

getChildModule<T extends ICoreAnyModule = ICoreAnyModule>(modName: string): T
Type Parameters
- T extends ICoreAnyModule = ICoreAnyModule
Parameters
- modName: string
Returns T
Implementation of IKernel.getChildModule

Inherited from CoreKernel.getChildModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1895

getConfigStore

getConfigStore(): IStore
Get environment config store

Returns IStore

Link
EnvStore
Implementation of IKernel.getConfigStore

Inherited from CoreKernel.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1865

getCoreModule

getCoreModule(): ICoreModule
get core kernel module

Returns ICoreModule
Implementation of IKernel.getCoreModule

Inherited from CoreKernel.getCoreModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1786

getCryptoClient

getCryptoClient(): ICClient | null
Get global crypt client

Returns ICClient | null

Link
ICoreCClient
Implementation of IKernel.getCryptoClient

Inherited from CoreKernel.getCryptoClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1841

getDb

getDb(): ICoreDb
Get database object of the core kernel module

Returns ICoreDb

Link
ICoreDb
Implementation of IKernel.getDb

Inherited from CoreKernel.getDb
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1851

getDevMode

getDevMode(): boolean
Get dev mode flag

Returns boolean
Implementation of IKernel.getDevMode

Inherited from CoreKernel.getDevMode
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1869

getExtension

getExtension<
    A extends
        CoreKernelExtension<
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >,
>(
    name: string,
): A
Type Parameters
- A extends CoreKernelExtension<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Parameters
- name: string
  Name of the extension
Returns A

See
CoreKernelExtension
Implementation of IKernel.getExtension

Inherited from CoreKernel.getExtension
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1891

getLogger

getLogger(): CoreLogger
get global logger

Returns CoreLogger
Implementation of IKernel.getLogger

Inherited from CoreKernel.getLogger
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1794

getMetric

getMetric(): BaseKernelMetric<unknown> | null
Returns BaseKernelMetric<unknown> | null
Implementation of IKernel.getMetric
- Defined in src/Kernel.ts:61

getModCount

getModCount(full?: boolean): number
Parameters
- Optionalfull: boolean
Returns number
Inherited from CoreKernel.getModCount
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1896

getModule

getModule(): ICoreAnyModule
get base kernel module

Returns ICoreAnyModule
Implementation of IKernel.getModule

Inherited from CoreKernel.getModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1790

getName

getName(): string
Returns string
Implementation of IKernel.getName

Inherited from CoreKernel.getName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:227

getOffline

getOffline(): boolean
Get the offline flag

Returns boolean
Implementation of IKernel.getOffline

Inherited from CoreKernel.getOffline
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1855

getServiceList

getServiceList(
full?: boolean,
): ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Parameters
- Optionalfull: boolean
Returns ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Implementation of IKernel.getServiceList

Inherited from CoreKernel.getServiceList
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1908

getState

getState(): string
Get core state code

Returns string
Implementation of IKernel.getState

Inherited from CoreKernel.getState
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1830

hasCryptoClient

hasCryptoClient(): boolean
Has global crypt client

Returns boolean

Link
ICoreCClient
Implementation of IKernel.hasCryptoClient

Inherited from CoreKernel.hasCryptoClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1846

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.info

Inherited from CoreKernel.info
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:222

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Implementation of IKernel.lError

Inherited from CoreKernel.lError
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:226

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.log

Inherited from CoreKernel.log
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:220

on

on<A = any>(
event: string,
callback: (ik: CoreKernel<ICClient>, payload?: A) => Promise<unknown>,
): void
Set function run on trigger Cycle functions
Type Parameters
- A = any
Parameters
- event: string
- callback: (ik: CoreKernel<ICClient>, payload?: A) => Promise<unknown>
Returns void

See
KernelTrigger
Implementation of IKernel.on

Inherited from CoreKernel.on
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1821

setAppServerPort

setAppServerPort(port: number): void
Parameters
- port: number
Returns void
Implementation of IKernel.setAppServerPort
- Defined in src/Kernel.ts:53

setBaseModule

setBaseModule(module: ICoreAnyModule): void
Parameters
- module: ICoreAnyModule
Returns void
Implementation of IKernel.setBaseModule

Inherited from CoreKernel.setBaseModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1892

setCoreModule

setCoreModule<E extends ICoreModule>(module: E): void
Type Parameters
- E extends ICoreModule
Parameters
- module: E
Returns void
Inherited from CoreKernel.setCoreModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1893

setCryptoClient

setCryptoClient(crypto: ICClient | null): void
Set global crypt client
Parameters
- crypto: ICClient | null
Returns void

Link
ICoreCClient
Implementation of IKernel.setCryptoClient

Inherited from CoreKernel.setCryptoClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1836

setDevMode

setDevMode(mode: boolean): void
Set dev mode flag
Parameters
- mode: boolean
Returns void
Implementation of IKernel.setDevMode

Inherited from CoreKernel.setDevMode
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1873

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreKernel.setLogger
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:219

setOffline

setOffline(mode: boolean): void
Set the offline flag
Parameters
- mode: boolean
Returns void
Implementation of IKernel.setOffline

Inherited from CoreKernel.setOffline
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1860

setState

setState(message: string): void
Set core state code
Parameters
- message: string
Returns void
Implementation of IKernel.setState

Inherited from CoreKernel.setState
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1826

start

start(): Promise<boolean>
startup kernel

Returns Promise<boolean>
Implementation of IKernel.start

Inherited from CoreKernel.start
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1806

stop

stop(): Promise<boolean>
Returns Promise<boolean>
Implementation of IKernel.stop

Inherited from CoreKernel.stop
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1894

triggerEvent

triggerEvent<A = any>(event: string, payload?: A): Promise<unknown>
Run trigger function Cycle functions
Type Parameters
- A = any
Parameters
- event: string
- Optionalpayload: A
Returns Promise<unknown>

See
KernelEvent
Implementation of IKernel.triggerEvent

Inherited from CoreKernel.triggerEvent
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:1813

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.verbose

Inherited from CoreKernel.verbose
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:225

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IKernel.warn

Inherited from CoreKernel.warn
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:224

Class Kernel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Kernel

Properties

ProtectedappCode

ProtectedappName

ProtectedappVersion

Protectedchannel

ProtectedcoreModule

ProtectedcryptoClient

ProtecteddevMode

ProtectedenvStore

ProtectedeventMap

Protectedextension

ProtectedfolderCreateSkip

ProtectedglobalFolderKeys

ProtectedglobalLogger

ProtectedkernelModule

logger

Protectedmetric

ProtectedmoduleList

Protectedoffline

Protectedstate

ProtectedupdateSkip

Methods

addExtension

Parameters

Returns void

See

addModule

Parameters

Returns void

See

debug

Parameters

Returns void

error

Parameters

Returns void

getActionList

Parameters

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

getApiVersion

Returns number

getAppCode

Returns string

getAppName

Returns string

getAppServerPort

Returns number

getChildModule

Type Parameters

Parameters

Returns T

getConfigStore

Returns IStore

Link

getCoreModule

Returns ICoreModule

getCryptoClient

Returns ICClient | null

Link

getDb

Returns ICoreDb

Link

getDevMode

Returns boolean

getExtension

Type Parameters

Parameters

Returns A

See

`Protected`appCode

`Protected`appName

`Protected`appVersion

`Protected`channel

`Protected`coreModule

`Protected`cryptoClient

`Protected`devMode

`Protected`envStore

`Protected`eventMap

`Protected`extension

`Protected`folderCreateSkip

`Protected`globalFolderKeys

`Protected`globalLogger

`Protected`kernelModule

`Protected`metric

`Protected`moduleList

`Protected`offline

`Protected`state

`Protected`updateSkip