@slimio/core

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).

Requirements

• Node.js v10 or higher

Features / Roles

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

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).

const Core = require("@slimio/core");

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);

API

constructor(dirname: string, options?: Core.ConstructorOptions)

Create a new instance of Core Object. The argument dirname is the root directory where the core have to load his configuration and all addons.

The constructor take an optional options object which contain all options to configure the core Agent.

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

initialize(): Promise< this >

Initialize the Core (it will load configuration and addons). The loading of addons is lazy, so the response will be returned before the addons have had time to fully load.

exit(): Promise< void >

Stop the core and all affiliated ressources (addons, config etc..).

Note: Think to exit the process with an iteration + 1 (with setImmediate).

Dependencies

Name	Refactoring	Security Risk	Usage
@slimio/addon	⚠️Major	High	Addon default class
@slimio/config	Minor	High	Configuration interaction
@slimio/ipc	⚠️Major	High	Inter-process communication
@slimio/is	Minor	Low	Type checker
@slimio/safe-emitter	Minor	High	Safe emittter
@slimio/scheduler	Minor	Low	Scheduler
@slimio/utils	Minor	High	Bunch of useful functions
make-promises-safe	⚠️Major	High	Promise not exit process when fail

License

MIT