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

Abstract base class that defines the API for cache implementations within the core framework.

The cache is identified by a unique channel and module name. Concrete subclasses must provide the storage logic for all abstract methods.

Type Parameters

K extends ICoreKernel<any> = ICoreKernel<any>
Type of the kernel that must extend ICoreKernel.
T extends IDataBase<any, any> | null = any
Type of the database, which can be IDataBase or null.
P extends ICoreClient | null = any
Type of the client, which can be ICoreClient or null.
C extends ICoreCache | null = any
Type of the cache, which can be ICoreCache or null.
E extends ICorePresenter<any> | null = any
Type of the presenter, which can be ICorePresenter or null.

Hierarchy (View Summary)

BaseElement<K, T, P, C, E>
- BaseCache
  - InMemCache

Implements

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

Index

Constructors

constructor

new BaseCache<
    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,
>(
    channel: string,
    module: ICoreKernelModule<any, any, any, any, any>,
): BaseCache<K, T, P, C, E>
Type Parameters
- K extends ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>
  Type of the kernel that must extend ICoreKernel.
- T extends
      | IDataBase<
          any,
          any,
          any,
          ICoreKernel<any, ICoreAnyModule>,
          any,
          any,
          any,
          any,
      >
      | null = any
  Type of the database, which can be IDataBase or null.
- P extends ICoreClient | null = any
  Type of the client, which can be ICoreClient or null.
- C extends ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Type of the cache, which can be ICoreCache or null.
- E extends ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Type of the presenter, which can be ICorePresenter or null.
Parameters
- channel: string
- module: ICoreKernelModule<any, any, any, any, any>
Returns BaseCache<K, T, P, C, E>
Overrides BaseElement.constructor
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:633

Properties

`Protected`channel

channel: string

logger

logger: CoreLogger | null

Methods

`Abstract`clearAll

clearAll(): Promise<void>
Returns Promise<void>
Implementation of ICoreCache.clearAll
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:639

`Abstract`clearAllE

clearAllE(className: string): Promise<void>
Parameters
- className: string
Returns Promise<void>
Implementation of ICoreCache.clearAllE
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:641

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from BaseElement.debug
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:221

`Abstract`delete

delete(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
Implementation of ICoreCache.delete
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:638

`Abstract`deleteE

deleteE(className: string, e_id: string): Promise<boolean>
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Implementation of ICoreCache.deleteE
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:642

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from BaseElement.error
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:223

`Abstract`exist

exist(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Implementation of ICoreCache.exist
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:640

`Abstract`get

get(key: string): Promise<string | null>
Parameters
- key: string
Returns Promise<string | null>
Implementation of ICoreCache.get
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:637

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from BaseElement.getCClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:255

getConfigStore

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

`Abstract`getE

getE<R extends IEntity>(className: string, e_id: string): Promise<R | null>
Type Parameters
- R extends IEntity
Parameters
- className: string
- e_id: string
Returns Promise<R | null>
Implementation of ICoreCache.getE
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:643

getKernel

getKernel(): K
Returns K
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>
Inherited from BaseElement.getModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:253

getName

getName(): string
Returns string
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
Inherited from BaseElement.info
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:222

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
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
Inherited from BaseElement.log
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:220

`Abstract`set

set(key: string, val: string): Promise<void>
Parameters
- key: string
- val: string
Returns Promise<void>
Implementation of ICoreCache.set
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:636

`Abstract`setE

setE<R extends IEntity>(className: string, val: R): Promise<void>
Type Parameters
- R extends IEntity
Parameters
- className: string
- val: R
Returns Promise<void>
Implementation of ICoreCache.setE
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:644

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<void>
Returns Promise<void>
Implementation of ICoreCache.start
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:634

`Abstract`stop

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

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
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
Inherited from BaseElement.warn
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:224

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

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protectedchannel

logger

Methods

AbstractclearAll

Returns Promise<void>

AbstractclearAllE

Parameters

Returns Promise<void>

debug

Parameters

Returns void

Abstractdelete

Parameters

Returns Promise<void>

AbstractdeleteE

Parameters

Returns Promise<boolean>

error

Parameters

Returns void

Abstractexist

Parameters

Returns Promise<boolean>

Abstractget

Parameters

Returns Promise<string | null>

getCClient

Type Parameters

Returns X

getConfigStore

Returns IStore

AbstractgetE

Type Parameters

Parameters

Returns Promise<R | null>

getKernel

Returns K

getModule

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

getName

Returns string

info

Parameters

Returns void

lError

Parameters

Returns Error

log

Parameters

Returns void

Abstractset

Parameters

Returns Promise<void>

AbstractsetE

Type Parameters

Parameters

Returns Promise<void>

setLogger

Parameters

Returns void

Abstractstart

Returns Promise<void>

Abstractstop

Returns Promise<void>

verbose

Parameters

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

`Protected`channel

`Abstract`clearAll

`Abstract`clearAllE

`Abstract`delete

`Abstract`deleteE

`Abstract`exist

`Abstract`get

`Abstract`getE

`Abstract`set

`Abstract`setE

`Abstract`start

`Abstract`stop