Beignet API reference
Preparing search index...
@beignet/core
server
Module server
Classes
RuntimeIntegrityError
Interfaces
ActiveRequestContext
CorsConfig
CreateRuntimeIntegrityOptions
CsrfHooksOptions
CsrfTokenOptions
ErrorMappingConfig
ErrorMappingResult
ErrorReportingHooksOptions
HandlerArgs
HealthCheckDetail
HealthCheckResult
HealthConfig
HttpAdapter
HttpRequestLike
HttpResponseLike
IdempotencyHooksOptions
Logger
LoggingConfig
OpenAPIConfig
RateLimitOptions
RawRouteBuilder
RequestCorrelation
RouteHook
Routes
RunHealthChecksOptions
RuntimeIntegrityCheck
RuntimeIntegrityFinding
RuntimeIntegrityLogger
RuntimeIntegrityResult
RuntimeManifest
RuntimeManifestInput
RuntimeOutboxManifest
RuntimeRegistries
RuntimeRegistriesInput
SecurityHeadersOptions
ServerHook
ServerInstance
ServerInstrumentationOptions
StrictTransportSecurityOptions
TrustedProxyOptions
TrustedRequestInfo
Type Aliases
AddedCtxFromHooks
AfterSendHook
AnyUseCaseLike
AnyUseCaseRouteDef
AppEnvironment
AuthHookArgs
AuthHooksOptions
AuthRouteHooks
BeforeHandleHook
BeforeHandleResult
BeforeSendHook
BinderStatusOption
ContextSeed
CreateServerOptions
CsrfFailureReason
CtxWithIdempotency
CtxWithRateLimit
ErrorReporterResolver
ErrorReportingContext
ErrorReportingHookArgs
Handler
HandlerRouteDef
HealthCheck
HealthChecks
HttpAdapterApiHandler
HttpAdapterHandler
HttpResponse
IdempotencyPorts
InferBody
InferHeaders
InferPath
InferQuery
MaybePromise
OnRequestHook
RateLimitIpSource
RawRouteInit
RequestContextArgs
RequestStageTimings
ResolvedRoute
RouteDef
RouteDefinitionBuilder
RouteGroup
RouteGroupBuilder
RouteHookArgs
RuntimeIntegrityArtifact
RuntimeIntegrityFindingCode
RuntimeIntegrityFindingLocation
RuntimeIntegrityMode
ServerCaughtErrorHook
ServerContextConfig
ServerContextOptions
ServerUnhandledErrorMapper
ServiceContextArgs
ServiceContextInputArgs
TrustedProxyClientIpSource
TrustedProxyConfig
UseCaseFitsRoute
UseCaseRouteDef
UseCaseRouteInput
UseCaseRouteInputParts
Functions
applyCorsHeaders
applySecurityHeaders
clearActiveRequestContext
composeHooks
contractsFromRoutes
createAmbientAuditLog
createAuthHooks
createCorsHooks
createCsrfHooks
createErrorReportingHooks
createHealthHandler
createIdempotencyHooks
createLoggingHooks
createOpenAPIHandler
createRateLimitHooks
createRoutes
createRuntimeIntegrity
createSecurityHeadersHooks
createServer
defaultBinderInput
defaultMapErrorToResponse
defineRoutes
defineRuntimeManifest
defineRuntimeRegistries
defineServerContext
enterActiveRequestContext
getActiveRequestContext
inheritActiveRequestContext
inspectRuntimeIntegrity
loadProviderConfig
parseStandardSchema
resolveTrustedClientIp
resolveTrustedRequest
runHealthChecks
runRuntimeIntegrityCheck
shouldReportServerError
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
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Runtime
Integrity
Error
Interfaces
Active
Request
Context
Cors
Config
Create
Runtime
Integrity
Options
Csrf
Hooks
Options
Csrf
Token
Options
Error
Mapping
Config
Error
Mapping
Result
Error
Reporting
Hooks
Options
Handler
Args
Health
Check
Detail
Health
Check
Result
Health
Config
Http
Adapter
Http
Request
Like
Http
Response
Like
Idempotency
Hooks
Options
Logger
Logging
Config
Open
API
Config
Rate
Limit
Options
Raw
Route
Builder
Request
Correlation
Route
Hook
Routes
Run
Health
Checks
Options
Runtime
Integrity
Check
Runtime
Integrity
Finding
Runtime
Integrity
Logger
Runtime
Integrity
Result
Runtime
Manifest
Runtime
Manifest
Input
Runtime
Outbox
Manifest
Runtime
Registries
Runtime
Registries
Input
Security
Headers
Options
Server
Hook
Server
Instance
Server
Instrumentation
Options
Strict
Transport
Security
Options
Trusted
Proxy
Options
Trusted
Request
Info
Type Aliases
Added
Ctx
From
Hooks
After
Send
Hook
Any
Use
Case
Like
Any
Use
Case
Route
Def
App
Environment
Auth
Hook
Args
Auth
Hooks
Options
Auth
Route
Hooks
Before
Handle
Hook
Before
Handle
Result
Before
Send
Hook
Binder
Status
Option
Context
Seed
Create
Server
Options
Csrf
Failure
Reason
Ctx
With
Idempotency
Ctx
With
Rate
Limit
Error
Reporter
Resolver
Error
Reporting
Context
Error
Reporting
Hook
Args
Handler
Handler
Route
Def
Health
Check
Health
Checks
Http
Adapter
Api
Handler
Http
Adapter
Handler
Http
Response
Idempotency
Ports
Infer
Body
Infer
Headers
Infer
Path
Infer
Query
Maybe
Promise
On
Request
Hook
Rate
Limit
Ip
Source
Raw
Route
Init
Request
Context
Args
Request
Stage
Timings
Resolved
Route
Route
Def
Route
Definition
Builder
Route
Group
Route
Group
Builder
Route
Hook
Args
Runtime
Integrity
Artifact
Runtime
Integrity
Finding
Code
Runtime
Integrity
Finding
Location
Runtime
Integrity
Mode
Server
Caught
Error
Hook
Server
Context
Config
Server
Context
Options
Server
Unhandled
Error
Mapper
Service
Context
Args
Service
Context
Input
Args
Trusted
Proxy
Client
Ip
Source
Trusted
Proxy
Config
Use
Case
Fits
Route
Use
Case
Route
Def
Use
Case
Route
Input
Use
Case
Route
Input
Parts
Functions
apply
Cors
Headers
apply
Security
Headers
clear
Active
Request
Context
compose
Hooks
contracts
From
Routes
create
Ambient
Audit
Log
create
Auth
Hooks
create
Cors
Hooks
create
Csrf
Hooks
create
Error
Reporting
Hooks
create
Health
Handler
create
Idempotency
Hooks
create
Logging
Hooks
create
Open
API
Handler
create
Rate
Limit
Hooks
create
Routes
create
Runtime
Integrity
create
Security
Headers
Hooks
create
Server
default
Binder
Input
default
Map
Error
To
Response
define
Routes
define
Runtime
Manifest
define
Runtime
Registries
define
Server
Context
enter
Active
Request
Context
get
Active
Request
Context
inherit
Active
Request
Context
inspect
Runtime
Integrity
load
Provider
Config
parse
Standard
Schema
resolve
Trusted
Client
Ip
resolve
Trusted
Request
run
Health
Checks
run
Runtime
Integrity
Check
should
Report
Server
Error
References
Any
Ports
App
Error
Config
Validation
Error
Contract
Like
Http
Contract
Config
Infer
Output
read
Env
resolve
Contract
Resolve
Contract
Schema
Validation
Error
Service
Provider
Standard
Schema
Standard
Schema
V1
Beignet API reference
Loading...