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

Abstract service class that represents a unit of functionality within the Core framework. Concrete implementations must provide the start and stop lifecycle methods.

Type Parameters

K extends ICoreKernel<any> = ICoreKernel<any>
Kernel type extending ICoreKernel.
T extends IDataBase<any, any> | null = any
DataBase type or {@code null} extending IDataBase.
P extends ICoreClient | null = any
Client type or {@code null} extending ICoreClient.
C extends ICoreCache | null = any
Cache type or {@code null} extending ICoreCache.
E extends ICorePresenter<any> | null = any
Presenter type or {@code null} extending ICorePresenter.

Hierarchy (View Summary)

BaseElement<K, T, P, C, E>
- BaseService
  - BaseLoopService
  - CoreTriggerService

Implements

ICoreService<K, T, P, C, E>

Index

Constructors

constructor

new BaseService<
    K extends
        ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>,
    T extends
        | IDataBase<
            any,
            any,
            any,
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >
        | null = any,
    P extends ICoreClient
    | null = any,
    C extends
        ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any,
    E extends
        | ICorePresenter<
            any,
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >
        | null = any,
>(
    name: string,
    module: ICoreKernelModule<K, T, P, C, E>,
    skipAutoStart?: boolean,
): BaseService<K, T, P, C, E>
Type Parameters
- K extends ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>
  Kernel type extending ICoreKernel.
- T extends
      | IDataBase<
          any,
          any,
          any,
          ICoreKernel<any, ICoreAnyModule>,
          any,
          any,
          any,
          any,
      >
      | null = any
  DataBase type or {@code null} extending IDataBase.
- P extends ICoreClient | null = any
  Client type or {@code null} extending ICoreClient.
- C extends ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Cache type or {@code null} extending ICoreCache.
- E extends ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Presenter type or {@code null} extending ICorePresenter.
Parameters
- name: string
- module: ICoreKernelModule<K, T, P, C, E>
- OptionalskipAutoStart: boolean
Returns BaseService<K, T, P, C, E>
Overrides BaseElement.constructor
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:906

Properties

`Protected`channel

channel: string

forceStop

forceStop: boolean

logger

logger: CoreLogger | null

skipAutoStart

skipAutoStart: boolean

state

state: ServiceStates

Methods

debug

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

Inherited from BaseElement.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 ICoreService.error

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

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Implementation of ICoreService.getCClient

Inherited from BaseElement.getCClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:255

getConfigStore

getConfigStore(): IStore
Returns IStore
Implementation of ICoreService.getConfigStore

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

getKernel

getKernel(): K
Returns K
Implementation of ICoreService.getKernel

Inherited from BaseElement.getKernel
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:252

getModule

getModule(): ICoreKernelModule<K, T, P, C, E>
Returns ICoreKernelModule<K, T, P, C, E>
Implementation of ICoreService.getModule

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

getName

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

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

info

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

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

isRunning

isRunning(): boolean
Returns boolean
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:911

lError

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

Inherited from BaseElement.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 ICoreService.log

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

setLogger

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

`Abstract`start

start(): Promise<any>
Returns Promise<any>
Implementation of ICoreService.start
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:909

`Abstract`stop

stop(): Promise<any>
Returns Promise<any>
Implementation of ICoreService.stop
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:910

verbose

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

Inherited from BaseElement.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 ICoreService.warn

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

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

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protectedchannel

forceStop

logger

skipAutoStart

state

Methods

debug

Parameters

Returns void

error

Parameters

Returns void

getCClient

Type Parameters

Returns X

getConfigStore

Returns IStore

getKernel

Returns K

getModule

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

getName

Returns string

info

Parameters

Returns void

isRunning

Returns boolean

lError

Parameters

Returns Error

log

Parameters

Returns void

setLogger

Parameters

Returns void

Abstractstart

Returns Promise<any>

Abstractstop

Returns Promise<any>

verbose

Parameters

Returns void

warn

Parameters

Returns void

Settings

On This Page

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

`Protected`channel

`Abstract`start

`Abstract`stop