Beignet API reference
    Preparing search index...

    Interface ServerHook<Ctx, Ports>

    Server lifecycle hook collection.

    Hooks run in the order they are registered. onRequest can short-circuit before context creation; beforeHandle can replace context or short-circuit; beforeSend can replace the outgoing response; afterSend observes the final response.

    interface ServerHook<Ctx, Ports extends AnyPorts = AnyPorts> {
        afterSend?: AfterSendHook<Ctx, HttpContractConfig>;
        beforeHandle?: BeforeHandleHook<Ctx, HttpContractConfig>;
        beforeSend?: BeforeSendHook<Ctx, HttpContractConfig>;
        mapUnhandledError?: ServerUnhandledErrorMapper<Ctx, HttpContractConfig>;
        name?: string;
        onCaughtError?: ServerCaughtErrorHook<Ctx, HttpContractConfig>;
        onRequest?: OnRequestHook<Ports, HttpContractConfig>;
    }

    Type Parameters

    Index

    Properties

    afterSend? beforeHandle? beforeSend? mapUnhandledError? name? onCaughtError? onRequest?

    Properties

    afterSend?: AfterSendHook<Ctx, HttpContractConfig>

    Observes the final response after send preparation.

    beforeHandle?: BeforeHandleHook<Ctx, HttpContractConfig>

    Runs after request parsing and context creation.

    beforeSend?: BeforeSendHook<Ctx, HttpContractConfig>

    Runs before a framework-neutral response is returned.

    mapUnhandledError?: ServerUnhandledErrorMapper<Ctx, HttpContractConfig>

    Maps unexpected errors to responses.

    name?: string

    Optional name used in diagnostics and devtools.

    onCaughtError?: ServerCaughtErrorHook<Ctx, HttpContractConfig>

    Observes framework-caught errors.

    onRequest?: OnRequestHook<Ports, HttpContractConfig>

    Runs after route matching and before body/query/header parsing.

    Settings

    Member Visibility

    On This Page

    Properties