Beignet API reference
    Preparing search index...

    Interface NextServer<Ctx, Ports>

    Beignet server adapted for Next.js route handlers and server components.

    interface NextServer<Ctx, Ports extends AnyPorts = AnyPorts> {
        api: (req: Request) => Promise<Response>;
        contracts: readonly ContractLike[];
        createContextFromNext: () => Promise<Ctx>;
        ports: Ports;
        route: <CLike extends ContractLike>(
            contractLike: CLike,
        ) => {
            handle: (
                fn: Handler<Ctx, ResolveContract<CLike>>,
            ) => (req: Request) => Promise<Response>;
        };
        stop: () => Promise<void>;
    }

    Type Parameters

    Index

    Properties

    api contracts createContextFromNext ports route stop

    Properties

    api: (req: Request) => Promise<Response>

    Catch-all Next.js route handler.

    contracts: readonly ContractLike[]

    Registered contract inputs.

    createContextFromNext: () => Promise<Ctx>

    Create app context from next/headers for Server Components.

    ports: Ports

    Final app ports after provider setup.

    route: <CLike extends ContractLike>(
        contractLike: CLike,
    ) => {
        handle: (
            fn: Handler<Ctx, ResolveContract<CLike>>,
        ) => (req: Request) => Promise<Response>;
    }

    Register and build a single Next.js route handler imperatively.

    stop: () => Promise<void>

    Stop installed providers.

    Settings

    Member Visibility

    On This Page

    Properties