Beignet API reference
    Preparing search index...

    Module server

    Interfaces

    CorsConfig
    ErrorMappingConfig
    ErrorMappingResult
    HandlerArgs
    HealthCheckResult
    HealthConfig
    HttpRequestLike
    HttpResponseLike
    Logger
    LoggingConfig
    OpenAPIConfig
    RateLimitOptions
    ServerHook
    ServerInstance

    Type Aliases

    AfterSendHook
    AppEnvironment
    AuthHookArgs
    AuthHookAssignArgs
    AuthHookMode
    AuthHookModeInput
    AuthHooksOptions
    AuthHookUnauthorizedArgs
    BeforeHandleHook
    BeforeHandleResult
    BeforeSendHook
    CreateServerOptions
    CtxWithAuthPort
    CtxWithRateLimit
    Handler
    HttpResponse
    InferBody
    InferHeaders
    InferPath
    InferQuery
    MaybePromise
    OnRequestHook
    ResolvedRoute
    RouteDef
    RouteGroup
    ServerCaughtErrorHook
    ServerUnhandledErrorMapper

    Functions

    applyCorsHeaders
    composeHooks
    contractsFromRoutes
    createAuthHooks
    createCorsHooks
    createHealthHandler
    createLoggingHooks
    createOpenAPIHandler
    createRateLimitHooks
    createServer
    defaultMapErrorToResponse
    defineRouteGroup
    defineRoutes
    loadProviderConfig
    parseStandardSchema

    References

    AnyPorts → AnyPorts
    AppError → AppError
    ConfigValidationError → ConfigValidationError
    ContractLike → ContractLike
    HttpContractConfig → HttpContractConfig
    InferOutput → InferOutput
    readEnv → readEnv
    resolveContract → resolveContract
    ResolveContract → ResolveContract
    SchemaValidationError → SchemaValidationError
    ServiceProvider → ServiceProvider
    StandardSchema → StandardSchema
    StandardSchemaV1 → StandardSchemaV1

    Settings

    Member Visibility

    On This Page

    Interfaces
    Type Aliases
    Functions
    References