Beignet API reference
    Preparing search index...

    Interface ServiceProviderMetadata

    Static provider metadata used by docs and app-local tooling.

    Metadata is descriptive. It does not change provider setup, ordering, or runtime port merging behavior.

    Reusable provider packages should also declare package-owned beignet.provider metadata in package.json so external tooling can inspect provider facts without importing runtime code.

    interface ServiceProviderMetadata {
        env?: readonly string[];
        packageName?: string;
        ports?: readonly string[];
        requires?: readonly string[];
        watchers?: readonly string[];
    }
    Index
    env? packageName? ports? requires? watchers?
    env?: readonly string[]

    Environment variables this provider reads directly or via config loading.

    packageName?: string

    Package that exports this provider, when it comes from a reusable package.

    ports?: readonly string[]

    App port keys this provider contributes or replaces.

    requires?: readonly string[]

    App port keys this provider expects previous providers or base app ports to have installed before setup runs.

    watchers?: readonly string[]

    Devtools watcher names this provider can emit through provider instrumentation.

    Settings
    Member Visibility

    On This Page
    Properties