Module

x/hono/context.ts

Ultrafast web framework for the Edges
Extremely Popular
Go to Latest
File
import { HonoRequest } from './request.ts'import { FetchEventLike } from './types.ts'import type { Env, NotFoundHandler, Input, TypedResponse } from './types.ts'import type { CookieOptions } from './utils/cookie.ts'import { serialize } from './utils/cookie.ts'import type { StatusCode } from './utils/http-status.ts'import type { JSONValue, InterfaceToType } from './utils/types.ts'
type Runtime = 'node' | 'deno' | 'bun' | 'workerd' | 'fastly' | 'edge-light' | 'lagon' | 'other'type HeaderRecord = Record<string, string | string[]>type Data = string | ArrayBuffer | ReadableStream
export interface ExecutionContext { waitUntil(promise: Promise<unknown>): void passThroughOnException(): void}export interface ContextVariableMap {}
interface Get<E extends Env> { <Key extends keyof ContextVariableMap>(key: Key): ContextVariableMap[Key] <Key extends keyof E['Variables']>(key: Key): E['Variables'][Key]}
interface Set<E extends Env> { <Key extends keyof ContextVariableMap>(key: Key, value: ContextVariableMap[Key]): void <Key extends keyof E['Variables']>(key: Key, value: E['Variables'][Key]): void}
interface NewResponse { (data: Data | null, status?: StatusCode, headers?: HeaderRecord): Response (data: Data | null, init?: ResponseInit): Response}
interface BodyRespond extends NewResponse {}
interface TextRespond { (text: string, status?: StatusCode, headers?: HeaderRecord): Response (text: string, init?: ResponseInit): Response}
interface JSONRespond { <T = JSONValue>(object: T, status?: StatusCode, headers?: HeaderRecord): Response <T = JSONValue>(object: T, init?: ResponseInit): Response}
interface JSONTRespond { <T>( object: InterfaceToType<T> extends JSONValue ? T : JSONValue, status?: StatusCode, headers?: HeaderRecord ): TypedResponse< InterfaceToType<T> extends JSONValue ? JSONValue extends InterfaceToType<T> ? never : T : never > <T>( object: InterfaceToType<T> extends JSONValue ? T : JSONValue, init?: ResponseInit ): TypedResponse< InterfaceToType<T> extends JSONValue ? JSONValue extends InterfaceToType<T> ? never : T : never >}
interface HTMLRespond { (html: string, status?: StatusCode, headers?: HeaderRecord): Response (html: string, init?: ResponseInit): Response}
type ContextOptions<E extends Env> = { env: E['Bindings'] executionCtx?: FetchEventLike | ExecutionContext | undefined notFoundHandler?: NotFoundHandler<E> path?: string params?: Record<string, string>}
export class Context< // eslint-disable-next-line @typescript-eslint/no-explicit-any E extends Env = any, // eslint-disable-next-line @typescript-eslint/no-explicit-any P extends string = any, I extends Input = {}> { env: E['Bindings'] = {} finalized: boolean = false error: Error | undefined = undefined
// eslint-disable-next-line @typescript-eslint/no-explicit-any private _req?: HonoRequest<any, any> private _status: StatusCode = 200 private _exCtx: FetchEventLike | ExecutionContext | undefined // _executionCtx private _pre: boolean = false // _pretty private _preS: number = 2 // _prettySpace private _map: Record<string, unknown> | undefined private _h: Headers | undefined = undefined // _headers private _pH: Record<string, string> | undefined = undefined // _preparedHeaders private _res: Response | undefined private _path: string = '/' private _params?: Record<string, string> | null private rawRequest?: Request | null private notFoundHandler: NotFoundHandler<E> = () => new Response()
constructor(req: Request, options?: ContextOptions<E>) { this.rawRequest = req if (options) { this._exCtx = options.executionCtx this._path = options.path ?? '/' this._params = options.params this.env = options.env if (options.notFoundHandler) { this.notFoundHandler = options.notFoundHandler } } }
get req(): HonoRequest<P, I['out']> { if (this._req) { return this._req } else { // eslint-disable-next-line @typescript-eslint/no-non-null-assertion this._req = new HonoRequest(this.rawRequest!, this._path, this._params!) this.rawRequest = undefined this._params = undefined return this._req } }
get event(): FetchEventLike { if (this._exCtx instanceof FetchEventLike) { return this._exCtx } else { throw Error('This context has no FetchEvent') } }
get executionCtx(): ExecutionContext { if (this._exCtx) { return this._exCtx as ExecutionContext } else { throw Error('This context has no ExecutionContext') } }
get res(): Response { return (this._res ||= new Response('404 Not Found', { status: 404 })) }
set res(_res: Response | undefined) { if (this._res && _res) { this._res.headers.delete('content-type') this._res.headers.forEach((v, k) => { _res.headers.set(k, v) }) } this._res = _res this.finalized = true }
header = (name: string, value: string | undefined, options?: { append?: boolean }): void => { // Clear the header if (value === undefined) { if (this._h) { this._h.delete(name) } else if (this._pH) { delete this._pH[name.toLocaleLowerCase()] } if (this.finalized) { this.res.headers.delete(name) } return }
if (options?.append) { if (!this._h) { this._h = new Headers(this._pH) this._pH = {} } this._h.append(name, value) } else { if (this._h) { this._h.set(name, value) } else { this._pH ??= {} this._pH[name.toLowerCase()] = value } }
if (this.finalized) { if (options?.append) { this.res.headers.append(name, value) } else { this.res.headers.set(name, value) } } }
status = (status: StatusCode): void => { this._status = status }
set: Set<E> = (key: string, value: unknown) => { this._map ||= {} this._map[key as string] = value }
get: Get<E> = (key: string) => { return this._map ? this._map[key] : undefined }
pretty = (prettyJSON: boolean, space: number = 2): void => { this._pre = prettyJSON this._preS = space }
newResponse: NewResponse = ( data: Data | null, arg?: StatusCode | ResponseInit, headers?: HeaderRecord ): Response => { // Optimized if (!headers && !this._h && !this._res && !arg && this._status === 200) { return new Response(data, { headers: this._pH, }) }
// Return Response immediately if arg is RequestInit. if (arg && typeof arg !== 'number') { const res = new Response(data, arg) const contentType = this._pH?.['content-type'] if (contentType) { res.headers.set('content-type', contentType) } return res }
const status = arg ?? this._status this._pH ??= {}
this._h ??= new Headers() for (const [k, v] of Object.entries(this._pH)) { this._h.set(k, v) }
if (this._res) { this._res.headers.forEach((v, k) => { this._h?.set(k, v) }) for (const [k, v] of Object.entries(this._pH)) { this._h.set(k, v) } }
headers ??= {} for (const [k, v] of Object.entries(headers)) { if (typeof v === 'string') { this._h.set(k, v) } else { this._h.delete(k) for (const v2 of v) { this._h.append(k, v2) } } }
return new Response(data, { status, headers: this._h, }) }
body: BodyRespond = ( data: Data | null, arg?: StatusCode | RequestInit, headers?: HeaderRecord ): Response => { return typeof arg === 'number' ? this.newResponse(data, arg, headers) : this.newResponse(data, arg) }
text: TextRespond = ( text: string, arg?: StatusCode | RequestInit, headers?: HeaderRecord ): Response => { // If the header is empty, return Response immediately. // Content-Type will be added automatically as `text/plain`. if (!this._pH) { if (!headers && !this._res && !this._h && !arg) { return new Response(text) } this._pH = {} } // If Content-Type is not set, we don't have to set `text/plain`. // Fewer the header values, it will be faster. if (this._pH['content-type']) { this._pH['content-type'] = 'text/plain; charset=UTF-8' } return typeof arg === 'number' ? this.newResponse(text, arg, headers) : this.newResponse(text, arg) }
json: JSONRespond = <T = {}>( object: T, arg?: StatusCode | RequestInit, headers?: HeaderRecord ) => { const body = this._pre ? JSON.stringify(object, null, this._preS) : JSON.stringify(object) this._pH ??= {} this._pH['content-type'] = 'application/json; charset=UTF-8' return typeof arg === 'number' ? this.newResponse(body, arg, headers) : this.newResponse(body, arg) }
jsonT: JSONTRespond = <T>( object: InterfaceToType<T> extends JSONValue ? T : JSONValue, arg?: StatusCode | RequestInit, headers?: HeaderRecord ): TypedResponse< InterfaceToType<T> extends JSONValue ? JSONValue extends InterfaceToType<T> ? never : T : never > => { return { response: typeof arg === 'number' ? this.json(object, arg, headers) : this.json(object, arg), // eslint-disable-next-line @typescript-eslint/no-explicit-any data: object as any, format: 'json', } }
html: HTMLRespond = ( html: string, arg?: StatusCode | RequestInit, headers?: HeaderRecord ): Response => { this._pH ??= {} this._pH['content-type'] = 'text/html; charset=UTF-8' return typeof arg === 'number' ? this.newResponse(html, arg, headers) : this.newResponse(html, arg) }
redirect = (location: string, status: StatusCode = 302): Response => { this._h ??= new Headers() this._h.set('Location', location) return this.newResponse(null, status) }
/** @deprecated * Use Cookie Middleware instead of `c.cookie()`. The `c.cookie()` will be removed in v4. * * @example * * import { setCookie } from 'hono/cookie' * // ... * app.get('/', (c) => { * setCookie(c, 'key', 'value') * //... * }) */ cookie = (name: string, value: string, opt?: CookieOptions): void => { const cookie = serialize(name, value, opt) this.header('set-cookie', cookie, { append: true }) }
notFound = (): Response | Promise<Response> => { // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore return this.notFoundHandler(this) }
get runtime(): Runtime { // eslint-disable-next-line @typescript-eslint/no-explicit-any const global = globalThis as any
if (global?.Deno !== undefined) { return 'deno' }
if (global?.Bun !== undefined) { return 'bun' }
if (typeof global?.WebSocketPair === 'function') { return 'workerd' }
if (typeof global?.EdgeRuntime === 'string') { return 'edge-light' }
if (global?.fastly !== undefined) { return 'fastly' }
if (global?.__lagon__ !== undefined) { return 'lagon' }
if (global?.process?.release?.name === 'node') { return 'node' }
return 'other' }}