@bivarcs/extension v0.0.4

Extension

A class for creating extensions.
This package contains the Extension class and the ExtensionTarget class. Inherits Emitter.

Installation

Package Manager

npm: npm i @bivarcs/extension
yarn: yarn add @bivarcs/extension

A command is needed to prepare dependent libraries.

npm run dev:setup
yarn run dev:setup

Document

• API Documentation (via: Typedoc)

Usage

Extension

Create original extensions.

import {Extension} from './path/to'

class HogeExtension extends Extension {
  constructor(target, options) {
    super(target, options);

    // some code...
    target.on("someevent", (event) => {
      // ...
      console.log(event.data);  // "hello!"
    });
  }

  destroy() {
    super.destroy();
  }
}

Target of the extension.

Create a class that accepts extensions.

import {ExtensionTarget} from './path/to'

class HogeExtensionTarget extends ExtensionTarget {
  constructor(options) {
    super(options);

    this.emit("someevent", {
      data: "hello!",
    });
  }

  destroy() {
    super.destroy();
  }
}

new HogeExtensionTarget({
  extension: [
    HogeExtension.create({
      // some options
    }),
  ],
});

License

Extension is available under the MIT license.