BSB Node.js Type Definitions
    Preparing search index...

    Interface BSBPluginMetadata

    Plugin metadata information for enhanced discoverability and documentation. Used for auto-generating PLUGIN_CLIENT and bsb-plugin.json.

    v9: This metadata is now the single source of truth for plugin information, used to auto-generate both PLUGIN_CLIENT (for ServiceClient) and bsb-plugin.json.

    interface BSBPluginMetadata {
        name: string;
        description: string;
        version?: string;
        author?: string;
        license?: string;
        homepage?: string;
        repository?: string;
        tags?: string[];
        documentation?: string[];
        image?: string;
        initBeforePlugins?: string[];
        initAfterPlugins?: string[];
        runBeforePlugins?: string[];
        runAfterPlugins?: string[];
    }
    Index

    Properties

    name description version? author? license? homepage? repository? tags? documentation? image? initBeforePlugins? initAfterPlugins? runBeforePlugins? runAfterPlugins?

    Properties

    name: string

    Plugin identifier (e.g., "service-demo-todo")

    description: string

    Short description of what the plugin does

    version?: string

    Semantic version (e.g., "1.0.0")

    author?: string

    Author name or organization

    license?: string

    License type (e.g., "MIT", "AGPL-3.0")

    homepage?: string

    Documentation URL

    repository?: string

    Source repository URL

    tags?: string[]

    Searchable tags for plugin discovery

    documentation?: string[]

    Relative paths to markdown documentation files (e.g., ["./docs/plugin.md"])

    image?: string

    Relative path to plugin image file (PNG recommended)

    initBeforePlugins?: string[]

    This plugin must initialize before these plugins

    initAfterPlugins?: string[]

    This plugin must initialize after these plugins

    runBeforePlugins?: string[]

    This plugin must run before these plugins

    runAfterPlugins?: string[]

    This plugin must run after these plugins

    Settings

    Member Visibility

    On This Page

    Properties