Class ElectronKernel

Hierarchy

CoreKernel<ICoreCClient>
- ElectronKernel

Implements

IKernel

Constructors

constructor

new ElectronKernel(config): ElectronKernel
Default Constructor
Parameters
- config: {
      appCode: string;
      appName: string;
      appRoot?: string;
      envFilePath?: string;
      logger?: ((kernel) => CoreLogger);
      pathOverride?: string;
      preloadRoot?: string;
  }
  - appCode: string
  - appName: string
  - Optional appRoot?: string
  - Optional envFilePath?: string
  - Optional logger?: ((kernel) => CoreLogger)
    - (kernel): CoreLogger
      
      Parameters
      
      kernel: CoreKernel<any, ICoreAnyModule>
      
      Returns CoreLogger
  - Optional pathOverride?: string
  - Optional preloadRoot?: string
Returns ElectronKernel
Overrides CoreKernel.constructor
- Defined in src/ElectronKernel.ts:35

Properties

`Protected` appCode

appCode: string

`Protected` appName

appName: string

`Private` `Readonly` appRoot

appRoot: string

`Protected` appVersion

appVersion: string

`Protected` channel

channel: string

`Protected` coreModule

coreModule: ICoreModule

`Protected` cryptoClient

cryptoClient: null | ICoreCClient

`Protected` devMode

devMode: boolean

`Protected` envStore

envStore: IStore

`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

`Private` `Readonly` preloadRoot

preloadRoot: string

`Protected` state

state: any

`Private` tray

tray: null | Tray

`Protected` triggerMap

triggerMap: Map<string, ((kernel) => Promise<unknown>)>

Type declaration

- (kernel): Promise<unknown>
- Parameters
  - kernel: CoreKernel<ICoreCClient, ICoreAnyModule>
  Returns Promise<unknown>

`Protected` updateSkip

updateSkip: boolean

`Private` `Readonly` windowManager

windowManager: WindowManager

Methods

addModule

addModule(...module): void
register new module

In general there are two places to add Modules correctly: In the Kernel constructor or in the pre-trigger-function
Parameters
- Rest ...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/cjs/CoreKernel.d.ts:147

closeAllWindows

closeAllWindows(): void
Returns void
Implementation of IKernel.closeAllWindows
- Defined in src/ElectronKernel.ts:117

debug

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

Inherited from CoreKernel.debug
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:9

electronPre

electronPre(ik): Promise<unknown>
Parameters
- ik: ICoreKernel<any, ICoreAnyModule>
Returns Promise<unknown>
- Defined in src/ElectronKernel.ts:90

electronStart

electronStart(ik): Promise<unknown>
Parameters
- ik: ICoreKernel<any, ICoreAnyModule>
Returns Promise<unknown>
- Defined in src/ElectronKernel.ts:100

error

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

Inherited from CoreKernel.error
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:11

getActionList

getActionList(full?): ICoreAction<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Parameters
- Optional full: 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/cjs/CoreKernel.d.ts:163

getAppCode

getAppCode(): string
get app code

Returns string
Implementation of IKernel.getAppCode

Inherited from CoreKernel.getAppCode
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:67

getAppName

getAppName(): string
get app name

Returns string
Implementation of IKernel.getAppName

Inherited from CoreKernel.getAppName
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:63

getAppRoot

getAppRoot(): string
Returns string
Implementation of IKernel.getAppRoot
- Defined in src/ElectronKernel.ts:113

getChildModule

getChildModule<T>(modName): 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/cjs/CoreKernel.d.ts:151

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/cjs/CoreKernel.d.ts:130

getCoreModule

getCoreModule(): ICoreModule
get core kernel module

Returns ICoreModule
Implementation of IKernel.getCoreModule

Inherited from CoreKernel.getCoreModule
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:51

getCryptoClient

getCryptoClient(): null | ICoreCClient
Get global crypt client

Returns null | ICoreCClient

Link
ICoreCClient
Implementation of IKernel.getCryptoClient

Inherited from CoreKernel.getCryptoClient
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:106

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/cjs/CoreKernel.d.ts:116

getDevMode

getDevMode(): boolean
Get dev mode flag

Returns boolean
Implementation of IKernel.getDevMode

Inherited from CoreKernel.getDevMode
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:134

getLogger

getLogger(): CoreLogger
get global logger

Returns CoreLogger
Implementation of IKernel.getLogger

Inherited from CoreKernel.getLogger
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:59

getMainWindow

getMainWindow(): null | BrowserWindow
Returns null | BrowserWindow
Implementation of IKernel.getMainWindow
- Defined in src/ElectronKernel.ts:121

getModCount

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

getModule

getModule(): ICoreAnyModule
get base kernel module

Returns ICoreAnyModule
Implementation of IKernel.getModule

Inherited from CoreKernel.getModule
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:55

getName

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

Inherited from CoreKernel.getName
- Defined in node_modules/@grandlinex/core/dist/cjs/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/cjs/CoreKernel.d.ts:120

getPreloadRoot

getPreloadRoot(): string
Returns string
Implementation of IKernel.getPreloadRoot
- Defined in src/ElectronKernel.ts:109

getServiceList

getServiceList(full?): ICoreService<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>[]
Parameters
- Optional full: 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/cjs/CoreKernel.d.ts:164

getState

getState(): string
Get core state code

Returns string
Implementation of IKernel.getState

Inherited from CoreKernel.getState
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:95

getTray

getTray(): null | Tray
Returns null | Tray
Implementation of IKernel.getTray
- Defined in src/ElectronKernel.ts:133

getWindowManager

getWindowManager(): WindowManager
Returns WindowManager
Implementation of IKernel.getWindowManager
- Defined in src/ElectronKernel.ts:125

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/cjs/CoreKernel.d.ts:111

info

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

Inherited from CoreKernel.info
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:10

lError

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

Inherited from CoreKernel.lError
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:14

log

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

Inherited from CoreKernel.log
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:8

openNewWindow

openNewWindow(): Promise<void>
Returns Promise<void>
Implementation of IKernel.openNewWindow
- Defined in src/ElectronKernel.ts:137

reload

reload(): Promise<void>
Returns Promise<void>
Implementation of IKernel.reload
- Defined in src/ElectronKernel.ts:141

setBaseModule

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

Inherited from CoreKernel.setBaseModule
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:148

setCoreModule

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

setCryptoClient

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

Link
ICoreCClient
Implementation of IKernel.setCryptoClient

Inherited from CoreKernel.setCryptoClient
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:101

setDevMode

setDevMode(mode): 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/cjs/CoreKernel.d.ts:138

setLogger

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

setOffline

setOffline(mode): 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/cjs/CoreKernel.d.ts:125

setPreload

setPreload(title): Promise<void>
Parameters
- title: string
Returns Promise<void>
- Defined in src/ElectronKernel.ts:68

setState

setState(message): 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/cjs/CoreKernel.d.ts:91

setTray

setTray(tray): void
Parameters
- tray: null | Tray
Returns void
Implementation of IKernel.setTray
- Defined in src/ElectronKernel.ts:129

setTriggerFunction

setTriggerFunction(trigger, triggerFunc): void
Set function run on trigger Cycle functions
Parameters
- trigger: string
- triggerFunc: ((ik) => Promise<unknown>)
  - - (ik): Promise<unknown>
    - Parameters
      
      ik: CoreKernel<ICoreCClient, ICoreAnyModule>
      
      Returns Promise<unknown>
Returns void

See
KernelTrigger
Implementation of IKernel.setTriggerFunction

Inherited from CoreKernel.setTriggerFunction
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:86

start

start(): Promise<boolean>
startup kernel

Returns Promise<boolean>
Implementation of IKernel.start

Inherited from CoreKernel.start
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:71

stop

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

Inherited from CoreKernel.stop
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:150

triggerFunction

triggerFunction(trigger): Promise<unknown>
Run trigger function Cycle functions
Parameters
- trigger: string
Returns Promise<unknown>

See
KernelTrigger
Implementation of IKernel.triggerFunction

Inherited from CoreKernel.triggerFunction
- Defined in node_modules/@grandlinex/core/dist/cjs/CoreKernel.d.ts:78

verbose

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

Inherited from CoreKernel.verbose
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:13

warn

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

Inherited from CoreKernel.warn
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:12

Class ElectronKernel

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: { appCode: string; appName: string; appRoot?: string; envFilePath?: string; logger?: ((kernel) => CoreLogger); pathOverride?: string; preloadRoot?: string; }

appCode: string

appName: string

Optional appRoot?: string

Optional envFilePath?: string

Optional logger?: ((kernel) => CoreLogger)

Parameters

kernel: CoreKernel<any, ICoreAnyModule>

Returns CoreLogger

Optional pathOverride?: string

Optional preloadRoot?: string

Returns ElectronKernel

Properties

Protected appCode

Protected appName

Private Readonly appRoot

Protected appVersion

Protected channel

Protected coreModule

Protected cryptoClient

Protected devMode

Protected envStore

Protected globalLogger

Protected kernelModule

logger

Protected moduleList

Protected offline

Private Readonly preloadRoot

Protected state

Private tray

Protected triggerMap

Type declaration

Parameters

kernel: CoreKernel<ICoreCClient, ICoreAnyModule>

Returns Promise<unknown>

Protected updateSkip

Private Readonly windowManager

Methods

addModule

Parameters

Rest ...module: ICoreKernelModule<any, any, any, any, any>[]

Returns void

See

closeAllWindows

Returns void

debug

Parameters

Rest ...ags: unknown[]

Returns void

electronPre

Parameters

ik: ICoreKernel<any, ICoreAnyModule>

Returns Promise<unknown>

electronStart

Parameters

ik: ICoreKernel<any, ICoreAnyModule>

Returns Promise<unknown>

error

Parameters

Rest ...ags: unknown[]

Returns void

getActionList

Parameters

Optional full: boolean

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

getAppCode

Returns string

getAppName

Returns string

getAppRoot

config: {
appCode: string;
appName: string;
appRoot?: string;
envFilePath?: string;
logger?: ((kernel) => CoreLogger);
pathOverride?: string;
preloadRoot?: string;
}

`Optional` appRoot?: string

`Optional` envFilePath?: string

`Optional` logger?: ((kernel) => CoreLogger)

`Optional` pathOverride?: string

`Optional` preloadRoot?: string

`Protected` appCode

`Protected` appName

`Private` `Readonly` appRoot

`Protected` appVersion

`Protected` channel

`Protected` coreModule

`Protected` cryptoClient

`Protected` devMode

`Protected` envStore

`Protected` globalLogger

`Protected` kernelModule

`Protected` moduleList

`Protected` offline

`Private` `Readonly` preloadRoot

`Protected` state

`Private` tray

`Protected` triggerMap

`Protected` updateSkip

`Private` `Readonly` windowManager

`Rest` ...module: ICoreKernelModule<any, any, any, any, any>[]

`Rest` ...ags: unknown[]

`Rest` ...ags: unknown[]

`Optional` full: boolean

`Optional` full: boolean

`Optional` full: boolean

`Rest` ...ags: unknown[]

`Rest` ...ags: unknown[]