ShokupanContext
Defined in: src/context.ts:28
Type Parameters
Section titled “Type Parameters”State extends Record<string, any> = Record<string, any>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShokupanContext<
State>(request,server?,state?,app?,signal?,enableMiddlewareTracking?):ShokupanContext<State>
Defined in: src/context.ts:39
Parameters
Section titled “Parameters”request
Section titled “request”any
server?
Section titled “server?”Server
state?
Section titled “state?”State
signal?
Section titled “signal?”AbortSignal
enableMiddlewareTracking?
Section titled “enableMiddlewareTracking?”boolean = false
Returns
Section titled “Returns”ShokupanContext<State>
Properties
Section titled “Properties”_debug?
Section titled “_debug?”
optional_debug:DebugCollector
Defined in: src/context.ts:35
_finalResponse?
Section titled “_finalResponse?”
optional_finalResponse:Response
Defined in: src/context.ts:36
_rawBody?
Section titled “_rawBody?”
optional_rawBody:string|ArrayBuffer|Uint8Array<ArrayBufferLike>
Defined in: src/context.ts:37
readonlyoptionalapp:Shokupan
Defined in: src/context.ts:43
handlerStack
Section titled “handlerStack”handlerStack:
HandlerStackItem[] =[]
Defined in: src/context.ts:32
params
Section titled “params”params:
Record<string,string> ={}
Defined in: src/context.ts:30
renderer?
Section titled “renderer?”
optionalrenderer:JSXRenderer
Defined in: src/context.ts:408
JSX Rendering Function
request
Section titled “request”
readonlyrequest:any
Defined in: src/context.ts:40
response
Section titled “response”
readonlyresponse:ShokupanResponse
Defined in: src/context.ts:34
server?
Section titled “server?”
readonlyoptionalserver:Server
Defined in: src/context.ts:41
session
Section titled “session”session:
SessionData&object
Defined in: src/plugins/session.ts:200
Type Declaration
Section titled “Type Declaration”id:
string
destroy()
Section titled “destroy()”destroy(
callback):void
Parameters
Section titled “Parameters”callback
Section titled “callback”(err) => void
Returns
Section titled “Returns”void
regenerate()
Section titled “regenerate()”regenerate(
callback):void
Parameters
Section titled “Parameters”callback
Section titled “callback”(err) => void
Returns
Section titled “Returns”void
reload()
Section titled “reload()”reload(
callback):void
Parameters
Section titled “Parameters”callback
Section titled “callback”(err) => void
Returns
Section titled “Returns”void
save()
Section titled “save()”save(
callback):void
Parameters
Section titled “Parameters”callback
Section titled “callback”(err) => void
Returns
Section titled “Returns”void
touch()
Section titled “touch()”touch():
void
Returns
Section titled “Returns”void
sessionID
Section titled “sessionID”sessionID:
string
Defined in: src/plugins/session.ts:201
sessionStore
Section titled “sessionStore”sessionStore:
Store
Defined in: src/plugins/session.ts:202
signal?
Section titled “signal?”
readonlyoptionalsignal:AbortSignal
Defined in: src/context.ts:44
state:
State
Defined in: src/context.ts:31
Accessors
Section titled “Accessors”headers
Section titled “headers”Get Signature
Section titled “Get Signature”get headers():
any
Defined in: src/context.ts:167
Request headers
Returns
Section titled “Returns”any
Get Signature
Section titled “Get Signature”get host():
string
Defined in: src/context.ts:147
Request host (e.g. “localhost:3000”)
Returns
Section titled “Returns”string
hostname
Section titled “hostname”Get Signature
Section titled “Get Signature”get hostname():
string
Defined in: src/context.ts:142
Request hostname (e.g. “localhost”)
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get ip():
SocketAddress
Defined in: src/context.ts:137
Client IP address
Returns
Section titled “Returns”SocketAddress
method
Section titled “method”Get Signature
Section titled “Get Signature”get method():
any
Defined in: src/context.ts:81
HTTP method
Returns
Section titled “Returns”any
origin
Section titled “origin”Get Signature
Section titled “Get Signature”get origin():
string
Defined in: src/context.ts:162
Request origin (e.g. “http://localhost:3000”)
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get path():
any
Defined in: src/context.ts:85
Request path
Returns
Section titled “Returns”any
protocol
Section titled “protocol”Get Signature
Section titled “Get Signature”get protocol():
string
Defined in: src/context.ts:152
Request protocol (e.g. “http:”, “https:“)
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get query():
Record<string,any>
Defined in: src/context.ts:120
Request query params
Returns
Section titled “Returns”Record<string, any>
Get Signature
Section titled “Get Signature”get req():
any
Defined in: src/context.ts:77
Base request
Returns
Section titled “Returns”any
Get Signature
Section titled “Get Signature”get res():
ShokupanResponse
Defined in: src/context.ts:178
Base response object
Returns
Section titled “Returns”secure
Section titled “secure”Get Signature
Section titled “Get Signature”get secure():
boolean
Defined in: src/context.ts:157
Whether request is secure (https)
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get url():
URL
Defined in: src/context.ts:65
Returns
Section titled “Returns”URL
Methods
Section titled “Methods”body()
Section titled “body()”body<
T>():Promise<T>
Defined in: src/context.ts:283
Read request body
Type Parameters
Section titled “Type Parameters”T = any
Returns
Section titled “Returns”Promise<T>
file()
Section titled “file()”file(
path,fileOptions?,responseOptions?):Promise<Response>
Defined in: src/context.ts:384
Respond with a file
Parameters
Section titled “Parameters”string
fileOptions?
Section titled “fileOptions?”BlobPropertyBag
responseOptions?
Section titled “responseOptions?”ResponseInit
Returns
Section titled “Returns”Promise<Response>
get(
name):any
Defined in: src/context.ts:173
Get a request header
Parameters
Section titled “Parameters”string
Header name
Returns
Section titled “Returns”any
html()
Section titled “html()”html(
html,status?,headers?):Response
Defined in: src/context.ts:349
Respond with HTML content
Parameters
Section titled “Parameters”string
status?
Section titled “status?”number
headers?
Section titled “headers?”HeadersInit
Returns
Section titled “Returns”Response
json()
Section titled “json()”json(
data,status?,headers?):Response
Defined in: src/context.ts:298
Respond with a JSON object
Parameters
Section titled “Parameters”any
status?
Section titled “status?”number
headers?
Section titled “headers?”HeadersInit
Returns
Section titled “Returns”Response
jsx(
element,args?,status?,headers?):Promise<Response>
Defined in: src/context.ts:416
Render a JSX element
Parameters
Section titled “Parameters”element
Section titled “element”any
JSX Element
unknown
status?
Section titled “status?”number
HTTP Status
headers?
Section titled “headers?”HeadersInit
HTTP Headers
Returns
Section titled “Returns”Promise<Response>
redirect()
Section titled “redirect()”redirect(
url,status):Response
Defined in: src/context.ts:364
Respond with a redirect
Parameters
Section titled “Parameters”string
status
Section titled “status”number = 302
Returns
Section titled “Returns”Response
send()
Section titled “send()”send(
body?,options?):Response
Defined in: src/context.ts:267
Send a response
Parameters
Section titled “Parameters”BodyInit
Response body
options?
Section titled “options?”ResponseInit
Response options
Returns
Section titled “Returns”Response
Response
set(
key,value):ShokupanContext<State>
Defined in: src/context.ts:185
Helper to set a header on the response
Parameters
Section titled “Parameters”string
Header key
string
Header value
Returns
Section titled “Returns”ShokupanContext<State>
setCookie()
Section titled “setCookie()”setCookie(
name,value,options):ShokupanContext<State>
Defined in: src/context.ts:196
Set a cookie
Parameters
Section titled “Parameters”string
Cookie name
string
Cookie value
options
Section titled “options”CookieOptions = {}
Cookie options
Returns
Section titled “Returns”ShokupanContext<State>
status()
Section titled “status()”status(
status):Response
Defined in: src/context.ts:375
Respond with a status code DOES NOT CHAIN!
Parameters
Section titled “Parameters”status
Section titled “status”number
Returns
Section titled “Returns”Response
text()
Section titled “text()”text(
data,status?,headers?):Response
Defined in: src/context.ts:324
Respond with a text string
Parameters
Section titled “Parameters”string
status?
Section titled “status?”number
headers?
Section titled “headers?”HeadersInit
Returns
Section titled “Returns”Response