Class Kernel

Kernel

Hierarchy (View Summary)

CoreKernel<ICClient>
- Kernel

Implements

IKernel

Constructors

constructor

new Kernel(
    options: {
        apiVersion?: number;
        appCode: string;
        appName: string;
        envFilePath?: string;
        loadFromLocalEnv?: boolean;
        logger?: (k: CoreKernel<any>) => CoreLogger;
        pathOverride?: string;
        portOverride?: number;
    },
): Kernel
Default Constructor
Parameters
- options: {
      apiVersion?: number;
      appCode: string;
      appName: string;
      envFilePath?: string;
      loadFromLocalEnv?: boolean;
      logger?: (k: CoreKernel<any>) => CoreLogger;
      pathOverride?: string;
      portOverride?: number;
  }
  App Name
Returns Kernel
Overrides CoreKernel.constructor
- Defined in src/Kernel.ts:20

Properties

`Protected`appCode

appCode: string

`Protected`appName

appName: string

`Protected`appVersion

appVersion: string

`Protected`channel

channel: string

`Protected`coreModule

coreModule: ICoreModule

`Protected`cryptoClient

cryptoClient: null | ICClient<JwtExtend>

`Protected`devMode

devMode: boolean

`Protected`envStore

envStore: IStore

`Protected`eventMap

eventMap: Map<
string,
(kernel: CoreKernel<ICClient<JwtExtend>>) => Promise<unknown>,
>

`Protected`extension

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

`Protected`folderCreateSkip

folderCreateSkip: boolean

`Protected`globalLogger

globalLogger: CoreLogger

`Protected`kernelModule

kernelModule: null | ICoreAnyModule

logger

logger: null | CoreLogger

`Protected`moduleList

moduleList: ICoreKernelModule<any, any, any, any, any>[]

`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/mjs/CoreKernel.d.ts:155

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/mjs/CoreKernel.d.ts:149

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/mjs/classes/CoreLogChannel.d.ts:9

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/mjs/classes/CoreLogChannel.d.ts:11

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/mjs/CoreKernel.d.ts:176

getApiVersion

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

getAppCode

getAppCode(): string
get app code

Returns string
Implementation of IKernel.getAppCode
Inherited from CoreKernel.getAppCode
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:71

getAppName

getAppName(): string
get app name

Returns string
Implementation of IKernel.getAppName
Inherited from CoreKernel.getAppName
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:67

getAppServerPort

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

getChildModule

getChildModule<
T extends ICoreKernelModule<any, any, any, any, any> = ICoreAnyModule,
>(
modName: string,
): null | T
Type Parameters
- T extends ICoreKernelModule<any, any, any, any, any> = ICoreAnyModule
Parameters
- modName: string
Returns null | T
Inherited from CoreKernel.getChildModule
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:164

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/mjs/CoreKernel.d.ts:134

getCoreModule

getCoreModule(): ICoreModule
get core kernel module

Returns ICoreModule
Implementation of IKernel.getCoreModule
Inherited from CoreKernel.getCoreModule
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:55

getCryptoClient

getCryptoClient(): null | ICClient<JwtExtend>
Get global crypt client

Returns null | ICClient<JwtExtend>
Link
ICoreCClient
Implementation of IKernel.getCryptoClient
Inherited from CoreKernel.getCryptoClient
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:110

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/mjs/CoreKernel.d.ts:120

getDevMode

getDevMode(): boolean
Get dev mode flag

Returns boolean
Implementation of IKernel.getDevMode
Inherited from CoreKernel.getDevMode
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:138

getExtension

getExtension<
    A extends
        CoreKernelExtension<
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >,
>(
    name: string,
): undefined | A
Type Parameters
- A extends CoreKernelExtension<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Parameters
- name: string
  Name of the extension
Returns undefined | A
See
CoreKernelExtension
Implementation of IKernel.getExtension
Inherited from CoreKernel.getExtension
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:160

getLogger

getLogger(): CoreLogger
get global logger

Returns CoreLogger
Implementation of IKernel.getLogger
Inherited from CoreKernel.getLogger
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:63

getModCount

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

getModule

getModule(): ICoreAnyModule
get base kernel module

Returns ICoreAnyModule
Implementation of IKernel.getModule
Inherited from CoreKernel.getModule
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:59

getName

getName(): string
Returns string
Implementation of IKernel.getName
Inherited from CoreKernel.getName
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:15

getOffline

getOffline(): boolean
Get the offline flag

Returns boolean
Implementation of IKernel.getOffline
Inherited from CoreKernel.getOffline
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:124

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/mjs/CoreKernel.d.ts:177

getState

getState(): string
Get core state code

Returns string
Implementation of IKernel.getState
Inherited from CoreKernel.getState
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:99

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/mjs/CoreKernel.d.ts:115

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/mjs/classes/CoreLogChannel.d.ts:10

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/mjs/classes/CoreLogChannel.d.ts:14

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/mjs/classes/CoreLogChannel.d.ts:8

on

on(
event: string,
callback: (ik: CoreKernel<ICClient<JwtExtend>>) => Promise<unknown>,
): void
Set function run on trigger Cycle functions
Parameters
- event: string
- callback: (ik: CoreKernel<ICClient<JwtExtend>>) => Promise<unknown>
Returns void
See
KernelTrigger
Implementation of IKernel.on
Inherited from CoreKernel.on
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:90

responseCodeFunction

responseCodeFunction(data: { code: number; req: XRequest }): void
Parameters
- data: { code: number; req: XRequest }
Returns void
Implementation of IKernel.responseCodeFunction
- Defined in src/Kernel.ts:62

setAppServerPort

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

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/mjs/CoreKernel.d.ts:161

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/mjs/CoreKernel.d.ts:162

setCryptoClient

setCryptoClient(crypto: null | ICClient<JwtExtend>): void
Set global crypt client
Parameters
- crypto: null | ICClient<JwtExtend>
Returns void
Link
ICoreCClient
Implementation of IKernel.setCryptoClient
Inherited from CoreKernel.setCryptoClient
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:105

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/mjs/CoreKernel.d.ts:142

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreKernel.setLogger
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:7

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/mjs/CoreKernel.d.ts:129

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/mjs/CoreKernel.d.ts:95

start

start(): Promise<boolean>
startup kernel

Returns Promise<boolean>
Implementation of IKernel.start
Inherited from CoreKernel.start
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:75

stop

stop(): Promise<boolean>
Returns Promise<boolean>
Implementation of IKernel.stop
Inherited from CoreKernel.stop
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:163

triggerEvent

triggerEvent(event: string): Promise<unknown>
Run trigger function Cycle functions
Parameters
- event: string
Returns Promise<unknown>
See
KernelEvent
Implementation of IKernel.triggerEvent
Inherited from CoreKernel.triggerEvent
- Defined in node_modules/@grandlinex/core/dist/mjs/CoreKernel.d.ts:82

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/mjs/classes/CoreLogChannel.d.ts:13

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/mjs/classes/CoreLogChannel.d.ts:12

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

ProtectedglobalLogger

ProtectedkernelModule

logger

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

getConfigStore

Returns IStore

Link

getCoreModule

Returns ICoreModule

getCryptoClient

Returns null | ICClient<JwtExtend>

Link

getDb

Returns ICoreDb

Link

getDevMode

Returns boolean

getExtension

Type Parameters

Parameters

Returns undefined | A

See

getLogger

Returns CoreLogger

`Protected`appCode

`Protected`appName

`Protected`appVersion

`Protected`channel

`Protected`coreModule

`Protected`cryptoClient

`Protected`devMode

`Protected`envStore

`Protected`eventMap

`Protected`extension

`Protected`folderCreateSkip

`Protected`globalLogger

`Protected`kernelModule

`Protected`moduleList

`Protected`offline

`Protected`state

`Protected`updateSkip