@grandlinex/kernel
    Preparing search index...

    Class KernelModule

    Core kernel module

    // Default use

    class ExampleModulen extends CoreKernelModule<any, any, any, any, any> {
      constructor(module: ICoreKernel<any>) {
        super('example', module);
      }

      beforeServiceStart(): Promise<void> {
        return Promise.resolve(undefined);
      }

      final(): Promise<void> {
        return Promise.resolve(undefined);
      }

      initModule(): Promise<void> {
        return Promise.resolve(undefined);
      }

      startup(): Promise<void> {
        return Promise.resolve(undefined);
      }
    }

    class Kernel extends CoreKernel<any> {
      constructor() {
        super({ appName: 'TestName', appCode: 'testcode' });
        // OPTION 01
        this.addModule(new ExampleModulen(this));
      }
    }
    const kernel = new Kernel();
    // OPTION 02
      kernel.setTriggerFunction('pre', async (ik) => {
      ik.addModule(new ExampleModulen(ik));
    });

    kernel.start();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    channel logger trigger?

    Methods

    addAction addService addSrcBridge addTarBridge beforeServiceStart debug error final getActionList getBridgeModule getBridges getCache getClient getDb getDependencyList getKernel getLogger getName getPresenter getServiceList hasCache hasClient hasDb hasPresenter info initModule lError log notifyBridges register setCache setClient setDb setLogger setPresenter shutdown start startService startup stopService verbose waitForBridgeState warn

    Constructors

    Properties

    channel: string
    logger: null | CoreLogger
    trigger?: () => Promise<void>

    Optional trigger function to be executed during registration.

    Methods

    • Hook called before services are started.

      Returns Promise<void>

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Finalization logic for the module.

      Returns Promise<void>

    • Returns a bridge module by name.

      Type Parameters

      Parameters

      • name: string

        Name of the module

      Returns undefined | M

      The bridge module or undefined

    • Returns the cache instance.

      Returns InMemCache

      Error if cache is not set

    • Returns the client instance.

      Returns null

      Error if client is not set

    • Returns the database instance.

      Returns null

      Error if database is not set

    • Returns the list of dependency names.

      Returns string[]

    • Returns the name of the module.

      Returns string

    • Returns true if a cache is set.

      Returns boolean

    • Returns true if a client is set.

      Returns boolean

    • Returns true if a database is set.

      Returns boolean

    • Returns true if a presenter is set.

      Returns boolean

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Parameters

      • message: string

      Returns Error

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Notifies all target bridges of a state change.

      Parameters

      Returns void

    • Registers the module, actions, and services.

      Parameters

      • Optionalaction: string

        Optional kernel event to trigger

      Returns Promise<void>

    • Sets the cache instance.

      Parameters

      Returns void

    • Sets the client instance.

      Parameters

      • client: null

        The client to set

      Returns void

    • Sets the database instance.

      Parameters

      • db: null

        The database to set

      Returns void

    • Sets the presenter instance.

      Parameters

      Returns void

    • Shuts down the module and its services.

      Returns Promise<void>

    • Starts the presenter and the module.

      Returns Promise<void>

    • Startup logic for the module.

      Returns Promise<void>

    • Parameters

      • ...ags: unknown[]

      Returns void

    • Waits for all source bridges to reach a specific state.

      Parameters

      Returns Promise<void>

    • Parameters

      • ...ags: unknown[]

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods