SerenityJS
    Preparing search index...

    Module @serenityjs/plugins

    Plugins allow developers to create server sided modifications or extensions to the base server software. SerenityJS provides a powerfull set of tools to allow full control over your server. We provide a TypeScript and JavaSample plugin template, which can be found at our sample-plugin repository.

    When creating a new plugin, you will need to have NodeJS (LTS), and Visual Studio Code installed, and optionally Rust.

    First, you want access the sample-plugin repository, and create new repository using the template.

    Template Generation

    Next, you will choose the location and the name of your repository. In this case, we will use the name my-plugin. You can optionally check Include all branches in which this will include the JavaScript template from the sample-plugin. You can also add a description to explain what the plugin does.

    Creating Plugin

    Enumerations

    PluginType

    Classes

    Pipeline
    Plugin

    Interfaces

    PluginAfterEvents
    PluginBeforeEvents
    PluginOnEvents
    PluginOptions
    PluginPackage

    Type Aliases

    PluginEvents

    Variables

    DefaultPipelineProperties