@boost/plugin
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

Plugins - Boost

build status npm version

Plugin based architecture that supports module loading, custom types, registries, scopes, and more.

import { Registry, Pluggable } from '@boost/plugin';

export interface Renderable<T> extends Pluggable<T> {
  render(): string | Promise<string>;
}

const registry = new Registry<Renderable>('boost', 'plugin', {
  validate(plugin) {
    if (typeof plugin.render !== 'function') {
      throw new TypeError('Plugins require a `render()` method.');
    }
  },
});

const plugin = await registry.load('boost-plugin-example');

Features

  • Custom plugin types and registries.
  • Node module, file path, and configuration file loading strategies.
  • Multiple module name formats: public, scoped public, scoped private.
  • Structural contracts with life cycle events.
  • Factory function pattern for plugin creation.
  • Asynchronous by default.

Installation

yarn add @boost/plugin

Documentation

Package Sidebar

Install

npm i @boost/plugin

Weekly Downloads

17,336

Version

5.0.0

License

MIT

Unpacked Size

62.1 kB

Total Files

44

Last publish

Collaborators

  • milesj