@slimio/addon-factory

SlimIO Addon Factory

Usage no npm install needed!

<script type="module">
  import slimioAddonFactory from 'https://cdn.skypack.dev/@slimio/addon-factory';
</script>

README

AddonFactory

version Maintenance MIT dep size Known Vulnerabilities Build Status Greenkeeper badge

SlimIO Addon Factory. This package has been created to programmatically generate a SlimIO Addon (with all required default settings).

Requirements

Getting Started

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

$ npm i @slimio/addon-factory
# or
$ yarn add @slimio/addon-factory

Usage example

This example show you how to create an Addon with name myAddon and a callback that will return null.

const { AddonFactory, CallbackFactory } = require("@slimio/addon-factory");

async function main() {
    const cbTest = new CallbackFactory("callme")
        .return({ error: null });

    const myAddon = new AddonFactory("myAddon")
        .addCallback(cbTest);

    await myAddon.generate("./addons");
}
main().catch(console.error);

API

AddonFactory

constructor(name: string, options?: AddonOptions)

Create a new Addon Factory. First argument is the name of the Addon.

const myAddon = new AddonFactory("myAddon");

Available options are:

name default value description
splitCallbackRegistration true separe function declaration from callback declaration
addCallback(callback: CallbackFactory): this

Add a given Callback to the Addon. The callback must be created using the CallbackFactory class.

scheduleCallback(callbackName: string, options: any): this

Schedule a callback by his name (must has been declared with addCallback before). Options are the same as the SlimIO Official Scheduler.

generate(path: string): Promise< this >

Generate addon at the given path location.

CallbackFactory

constructor(name: string)

Create a new CallbackFactory Object with a given name (the name of the callback). name must be indented in snake_case.

add(component: ComponentFactory): this

Add a new ComponentFactory. Look at the ComponentFactory and Built-in components sections.

return(value: any): this

Return any value. Under the hood we use JSON.stringify to put your value in the String source.

ComponentFactory

ComponentFactory has been designed to be an Abstraction for CallbackFactory. Use it to extend any component you want to add into a callback.

Exemple taken from the core test:

class MyStream extends ComponentFactory {
    // eslint-disable-next-line
    toString() {
        return "\tconst wS = new Addon.Stream();\n" +
            "\tsetTimeout(() => {wS.write('hello');wS.end();}, 200);\n" +
            "\treturn wS;\n";
    }
}

Built-in Components

Message

Message component has been build to publish a given message in a Callback.

const {
    AddonFactory, CallbackFactory, Components: { Message }
} = require("@slimio/addon-factory");

const cb = new CallbackFactory("callme")
    .add(new Message("AddonName.callme"))
    .add(new Message("AddonName.stream_com"))
    .return({ error: null });

const Ex = new AddonFactory("Ex")
    .addCallback(cb)
    .generate(__dirname);

Dependencies

Name Refactoring Security Risk Usage
@slimio/is Minor Low Type checker
@slimio/utils Minor High Bunch of useful functions
is-snake-case Minor Low Snake case checker

License

MIT