Core

The Core was created to load and manage SlimIO addons, it will create/handle communication between each addons.

Each addon are isolated from each others (designed like container above). You may be interested by the Gate addon as well if you want to learn how the core work and behave at higher level.

Requirements

• Node.js v12 or higher

Features / Roles

• (Re)loading addons.
• Manage communication between addons.
• Retention of communications in case of anomalies.
• Monitoring isolation.

The core as clean and well defined roles to be as much stable possible. Behavior related to addons communication and data exposition will be all related to the Gate addon (which is the right hand of the core). As an addon there is no way to talk to the core directly.

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/core
# or
$ yarn add @slimio/core

Usage example

A script that demonstrate how to load a default core (Configuration will be created dynamically).

import "make-promises-safe";

import { fileURLToPath } from 'url';
import { dirname } from 'path';

import Core from "@slimio/core";

const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);

async function main() {
    console.time("start_core");
    const core = await (new Core(__dirname)).initialize();
    console.timeEnd("start_core");

    // Handle exit signal!
    process.on("SIGINT", () => {
        console.error("Exiting SlimIO Agent (please wait)");
        core.exit().then(() => {
            setImmediate(process.exit);
        }).catch(function mainErrorHandler(error) {
            console.error(error);
            process.exit(1);
        });
    });
}
main().catch(console.error);

👀 Not that we use make-promises-safe to enforce Node.js DEP 00018.

Global

The core register himself as a global with the name slimio_core.

console.log(global.slimio_core);

The current core version is also available as global.coreVersion.

API

interface ConstructorOptions {
    silent?: boolean;
    autoReload?: number;
    toml?: boolean;
}

Dependencies

License

MIT