Example plugin API for the https://github.com/flowscripter/dynamic-plugin-framework
npm install @flowscripter/example-plugin-api




> Example plugin API for the
> dynamic-plugin-framework
Add the module:
bun add @flowscripter/example-plugin-api
Use the module:
``typescript
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...
}
}
`
Test:
bun test
NOTE: The following tasks use Deno as it excels at these and Bun does not
currently provide such functionality:
Format:
deno fmt
Lint:
deno lint index.ts
Generate HTML API Documentation:
deno doc --html --name=example-plugin-api index.ts
`mermaid``
classDiagram
class ExtensionPoint1 {
<
sayHello()
}
Refer to the
dynamic-plugin-framework
for an overview of what this example is demonstrating.
Link to auto-generated API docs:
MIT © Flowscripter