Class ElectronKernel

ElectronKernel

Hierarchy (View Summary)

CoreKernel<ICoreCClient>
- ElectronKernel

Implements

IKernel

Constructors

constructor

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

Properties

`Protected`appCode

appCode: string

`Protected`appName

appName: string

`Protected`appVersion

appVersion: string

`Protected`channel

channel: string

`Protected`coreModule

coreModule: ICoreModule

`Protected`cryptoClient

cryptoClient: ICoreCClient | null

`Protected`devMode

devMode: boolean

`Protected`envStore

envStore: IStore

`Protected`eventMap

eventMap: Map<string, (kernel: CoreKernel<ICoreCClient>) => 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: ICoreAnyModule | null

logger

logger: CoreLogger | null

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

closeAllWindows

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

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

electronPre

electronPre(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/ElectronKernel.ts:86

electronStart

electronStart(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/ElectronKernel.ts:96

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

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:71

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:67

getAppRoot

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

getChildModule

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

getCryptoClient

getCryptoClient(): ICoreCClient | null
Get global crypt client

Returns ICoreCClient | null
Link
ICoreCClient
Implementation of IKernel.getCryptoClient
Inherited from CoreKernel.getCryptoClient
- Defined in node_modules/@grandlinex/core/dist/cjs/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/cjs/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/cjs/CoreKernel.d.ts:138

getExtension

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

getMainWindow

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

getModCount

getModCount(full?: boolean): number
Parameters
- Optionalfull: boolean
Returns number
Inherited from CoreKernel.getModCount
- Defined in node_modules/@grandlinex/core/dist/cjs/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/cjs/CoreKernel.d.ts:59

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:124

getPreloadRoot

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

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

getTray

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

getWindowManager

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

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

on

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

openNewWindow

openNewWindow(): Promise<void>
OVERRIDING THIS TO CREATE OWN MAIN WINDOW FUNCTION

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

reload

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

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

setCryptoClient

setCryptoClient(crypto: ICoreCClient | null): void
Set global crypt client
Parameters
- crypto: ICoreCClient | null
Returns void
Link
ICoreCClient
Implementation of IKernel.setCryptoClient
Inherited from CoreKernel.setCryptoClient
- Defined in node_modules/@grandlinex/core/dist/cjs/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/cjs/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/cjs/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/cjs/CoreKernel.d.ts:129

setPreload

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

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

setTray

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

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:75

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

Class ElectronKernel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ElectronKernel

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

closeAllWindows

Returns void

debug

Parameters

Returns void

electronPre

Returns Promise<unknown>

electronStart

Returns Promise<unknown>

error

Parameters

Returns void

getActionList

Parameters

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

getAppCode

Returns string

getAppName

Returns string

getAppRoot

Returns string

getChildModule

Type Parameters

Parameters

Returns T | null

getConfigStore

Returns IStore

Link

getCoreModule

Returns ICoreModule

getCryptoClient

Returns ICoreCClient | null

Link

getDb

Returns ICoreDb

Link

getDevMode

Returns boolean

getExtension

Type Parameters

Parameters

`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