example-plugin-api

Example plugin API for the dynamic-plugin-framework

Bun Module Usage

Add the module:

bun add @flowscripter/example-plugin-api

Use the module:

import { EXTENSION_POINT_1, ExtensionPoint1 } from "@flowscripter/example-plugin-api";

// ExtensionPoint1 is identified by EXTENSION_POINT_1 identifier

class MyExtensionPointImplementation implements ExtensionPoint1 {
  public sayHello(): void {
    // greetings...
  }
}

Development

Build (produces dist/ for Node.js and TypeScript consumers; Bun uses raw source directly):

bun run build

Test:

bun test

Format:

bunx oxfmt

Lint:

bunx oxlint index.ts

Generate HTML API Documentation:

bunx typedoc index.ts

Documentation

Overview

classDiagram

   class ExtensionPoint1 {
      <<interface>>
      sayHello()
   }

Framework API

Refer to the dynamic-plugin-framework for an overview of what this example is demonstrating.

API

Link to auto-generated API docs:

API Documentation

License

MIT © Flowscripter