Plugin

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods
• Example usage

Class Definition

export abstract class Plugin {}

Properties

Property	Type	Description
name	string	The name of the plugin.

Constructor

new Plugin(name: string)

Parameter	Type	Description	Optional
name	string	The name of the plugin.

Methods

load()

load(manager: Manager): void

Load the plugin.

Parameter	Type	Description
manager	Manager	Manager class

---

unload()

unload(manager: Manager): void

Unload the plugin.

Parameter	Type	Description
manager	Manager	Manager class

Example usage

Using plugins

const { Manager } = require("magmastream");
const MyPlugin = require("my-magmastream-plugin");

const manager = new Manager({
    ...ManagerOptions,
    plugins: [new MyPlugin()],
});

Writing plugins

import { Plugin, Manager } from "magmastream";

export class MyPlugin extends Plugin {
    private options: Record<string, unknown>;

    constructor(options: Record<string, unknown>) {
        super("MyPlugin"); // Required: pass the plugin name to base constructor
        this.options = options;
    }

    load(manager: Manager): void {
        console.log(`[MyPlugin] Loaded with options:`, this.options);
        // Attach event listeners, modify behavior, etc.
    }

    unload(manager: Manager): void {
        console.log("[MyPlugin] Unloaded");
        // Cleanup listeners, free resources, etc.
    }
}