Skip to content
Shokupan
Search
Ctrl
K
Cancel
GitHub
Copy LLMs.txt URL
Select theme
Dark
Light
Auto
Getting Started
Introduction
Installation
Quick Start
Configuration
Releases
Core Concepts
Routing
Controllers
Middleware
Dependency Injection
Context
Static Files
WebSockets
Performance
Benchmarks
Plugins
Dashboard
API Explorer
WS Explorer
Authentication
Compression
CORS
GraphQL
Idempotency
MCP Server
NodeJS/Deno
OpenAPI Validation
Proxy
Rate Limiting
Resilience
Scalar (OpenAPI)
Security Headers
Socket.IO
Sessions
Validation
Migration Guides
Guides
From Express
From Koa
From NestJS
From Hono
From Fastify
Express Middleware
Guides
Advanced Features
AST Generation
Debugging
CLI Tools
Deployment
Global Type Augmentation
JSON Parser Configuration
Multipart Streaming
Plugin Dependencies
Production Best Practices
Testing
Reference
Roadmap
API
Enumerations
RouteParamType
Classes
ApiExplorerPlugin
AsyncApiPlugin
AuthPlugin
ClusterPlugin
Container
Dashboard
ErrorView
GracefulShutdown
GraphQLApolloPlugin
GraphQLYogaPlugin
HtmxPlugin
MCPServerPlugin
MemoryStore
OpenTelemetryPlugin
ScalarPlugin
Shokupan
ShokupanContext
ShokupanResponse
ShokupanRouter
ValidationError
Interfaces
ApiExplorerOptions
AsyncAPIOptions
AsyncApiPluginOptions
AsyncAPISpec
AuthConfig
AuthUser
ClusterOptions
CompressionOptions
CookieOptions
CorsOptions
DashboardConfig
DebugCollector
ErrorHandler
ErrorViewConfig
GracefulShutdownOptions
GraphQLPluginOptions
GraphQLYogaPluginOptions
HandlerStackItem
IdempotencyOptions
InlineWebSocketHandlers
MCPServerPluginOptions
OpenAPIOptions
OpenTelemetryOptions
ProcessResult
PromptConfig
ProviderConfig
ProxyOptions
RateLimitOptions
RequestLog
RequestOptions
ResourceConfig
RouteMetadata
SecurityHeadersOptions
ServerFactory
SessionContext
SessionCookieOptions
SessionData
SessionOptions
ShokupanHooks
ShokupanPlugin
ShokupanPluginOptions
SSEMessage
SSEStreamHelper
StaticServeHooks
StaticServeOptions
Store
StreamHelper
TextStreamHelper
ToolConfig
ValidationConfig
Type Aliases
DeepPartial
DefaultState
EmptyState
GuardAPISpec
HeadersInit
JSXRenderer
Method
MethodAPISpec
Middleware
NextFn
RouteParams
RouterAPISpec
ScalarPluginOptions
ShokupanConfig
ShokupanController
ShokupanHandler
ShokupanRequest
ShokupanRequestProps
ShokupanRoute
ShokupanRouteConfig
SSEStreamErrorHandler
StreamErrorHandler
TextStreamErrorHandler
Variables
AfterValidate
All
$appRoot
BeforeValidate
Body
$bodyParsed
$bodyParseError
$bodyType
$cachedBody
$cachedCookies
$cachedHost
$cachedHostname
$cachedOrigin
$cachedProtocol
$cachedQuery
$childControllers
$childRouters
$controllerHooks
$controllerPath
Ctx
$debug
Delete
$dispatch
$eventMethods
$finalResponse
Get
Head
Headers
HTTPMethods
$io
$isApplication
$isMounted
$isRouter
$isWebSocketRouter
$mcpPrompts
$mcpResources
$mcpTools
$middleware
$mountPath
OnRequestEnd
OnRequestError
OnRequestStart
OnResponseEnd
OnResponseStart
OnStop
$onWsMessage
Options
Param
$parent
Patch
Post
Put
Query
$rawBody
Req
$requestId
$resilienceConfig
$routeArgs
$routeMatched
$routeMethods
RouterRegistry
$routes
$routeSpec
ShokupanApplicationTree
ShokupanRequest
$socket
$url
$ws
$wsMessages
Functions
attachSocketIOBridge
compileValidators
compose
Compression
Controller
Cors
defineMetadata
enableOpenApiValidation
Event
getCallerInfo
getMetadata
getStateProperty
hasStateProperty
Idempotency
Inject
Injectable
OnClose
OnError
OnEvent
OnMessage
OnOpen
OnUpgrade
openApiValidator
precompileValidators
Prompt
Proxy
RateLimit
RateLimitMiddleware
requireStateProperty
Resource
SecurityHeaders
serveStatic
Session
Spec
Static
Tool
traceHandler
traceMiddleware
Use
useExpress
valibot
validate
WebsocketController
GitHub
Copy LLMs.txt URL
Select theme
Dark
Light
Auto
NextFn
NextFn
= () =>
Promise
<
any
>
Defined in:
src/util/types.ts:359
Returns
Section titled “Returns”
Promise
<
any
>