Beignet API reference
    Preparing search index...

    Type Alias ProviderSetupResult<ProvidedPorts>

    Result returned from provider setup.

    type ProviderSetupResult<ProvidedPorts extends ProviderPorts> = {
        ports?: ProvidedPorts;
        start?: (ctx: ProviderLifecycleContext) => MaybePromise<void>;
        stop?: (ctx: ProviderLifecycleContext) => MaybePromise<void>;
    }

    Type Parameters

    • ProvidedPorts extends ProviderPorts
    Index

    Properties

    ports? start? stop?

    Properties

    ports?: ProvidedPorts

    Ports contributed by this provider. Keys overwrite earlier ports with the same name at runtime. Prefer unique keys unless the replacement implements the same port contract.

    start?: (ctx: ProviderLifecycleContext) => MaybePromise<void>

    Optional hook called after all providers have contributed their ports.

    stop?: (ctx: ProviderLifecycleContext) => MaybePromise<void>

    Optional hook called when the server is stopped.

    Settings

    Member Visibility

    On This Page

    Properties