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.

    Package-level fields such as version, author, and license are sourced from package.json during build and publish steps.

    interface BSBPluginMetadata {
        name: string;
        description: string;
        homepage?: string;
        repository?: string;
        tags?: string[];
        documentation?: string[];
        image?: string;
    }
    Index

    Properties

    name: string

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

    description: string

    Short description of what the plugin does

    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)