Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319import { HonoRequest } from './request.ts'import type { TypedResponse } from './types.ts'import type { Env, NotFoundHandler, Input } 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 { PrettyJSON, JSONValue } 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<void>): void passThroughOnException(): void}export interface ContextVariableMap {}
type GetVariable<K, E extends Env> = K extends keyof E['Variables'] ? E['Variables'][K] : K extends keyof ContextVariableMap ? ContextVariableMap[K] : unknown
type ContextOptions<E extends Env> = { env: E['Bindings'] executionCtx?: FetchEvent | ExecutionContext | undefined notFoundHandler?: NotFoundHandler<E> paramData?: 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 _executionCtx: FetchEvent | ExecutionContext | undefined private _pretty: boolean = false private _prettySpace: number = 2 private _map: Record<string, unknown> | undefined private _headers: Headers | undefined = undefined private _preparedHeaders: Record<string, string> | undefined = undefined private _res: Response | undefined private _paramData?: 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._executionCtx = options.executionCtx this._paramData = options.paramData this.env = options.env if (options.notFoundHandler) { this.notFoundHandler = options.notFoundHandler } } }
get req(): HonoRequest<P, I> { if (this._req) { return this._req } else { // eslint-disable-next-line @typescript-eslint/no-non-null-assertion this._req = new HonoRequest(this.rawRequest!, this._paramData!) this.rawRequest = undefined this._paramData = undefined return this._req } }
get event(): FetchEvent { if (this._executionCtx instanceof FetchEvent) { return this._executionCtx } else { throw Error('This context has no FetchEvent') } }
get executionCtx(): ExecutionContext { if (this._executionCtx) { return this._executionCtx 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) { if (this._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, options?: { append?: boolean }): void => { if (options?.append) { if (!this._headers) { this._headers = new Headers(this._preparedHeaders) } this._headers.append(name, value) } else { if (this._headers) { this._headers.set(name, value) } else { this._preparedHeaders ??= {} this._preparedHeaders[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 = <Key extends keyof E['Variables'] | keyof ContextVariableMap>( key: Key, value: GetVariable<Key, E> ): void => { this._map ||= {} this._map[key as string] = value }
get = <Key extends keyof E['Variables'] | keyof ContextVariableMap>( key: Key ): GetVariable<Key, E> => { return this._map?.[key as string] as GetVariable<Key, E> }
pretty = (prettyJSON: boolean, space: number = 2): void => { this._pretty = prettyJSON this._prettySpace = space }
newResponse = (data: Data | null, status?: StatusCode, headers?: HeaderRecord): Response => { // Optimized if (!headers && !this._headers && !this._res && !status) { return new Response(data, { headers: this._preparedHeaders, }) }
this._preparedHeaders ??= {}
if (!this._headers) { this._headers = new Headers() for (const [k, v] of Object.entries(this._preparedHeaders)) { this._headers.set(k, v) } }
if (this._res) { this._res.headers.forEach((v, k) => { this._headers?.set(k, v) }) for (const [k, v] of Object.entries(this._preparedHeaders)) { this._headers.set(k, v) } }
headers ??= {} for (const [k, v] of Object.entries(headers)) { if (typeof v === 'string') { this._headers.set(k, v) } else { this._headers.delete(k) for (const v2 of v) { this._headers.append(k, v2) } } }
return new Response(data, { status, headers: this._headers, }) }
body = ( data: Data | null, status: StatusCode = this._status, headers?: HeaderRecord ): Response => { return this.newResponse(data, status, headers) }
text = (text: string, status?: StatusCode, headers?: HeaderRecord): Response => { // If the header is empty, return Response immediately. // Content-Type will be added automatically as `text/plain`. if (!this._preparedHeaders) { if (!headers && !this._res && !this._headers && !status) { return new Response(text) } this._preparedHeaders = {} } // If Content-Type is not set, we don't have to set `text/plain`. // Fewer the header values, it will be faster. if (this._preparedHeaders['content-type']) { this._preparedHeaders['content-type'] = 'text/plain; charset=UTF8' } return this.newResponse(text, status, headers) }
json = <T = object>( object: T, status: StatusCode = this._status, headers?: HeaderRecord ): Response => { const body = this._pretty ? JSON.stringify(object, null, this._prettySpace) : JSON.stringify(object) this._preparedHeaders ??= {} this._preparedHeaders['content-type'] = 'application/json; charset=UTF-8' return this.newResponse(body, status, headers) }
jsonT = <T>( object: T extends JSONValue ? T : JSONValue, status: StatusCode = this._status, headers?: HeaderRecord ): TypedResponse<T extends JSONValue ? (JSONValue extends T ? never : PrettyJSON<T>) : never> => { return { response: this.json(object, status, headers), // eslint-disable-next-line @typescript-eslint/no-explicit-any data: object as any, format: 'json', } }
html = (html: string, status: StatusCode = this._status, headers?: HeaderRecord): Response => { this._preparedHeaders ??= {} this._preparedHeaders['content-type'] = 'text/html; charset=UTF-8' return this.newResponse(html, status, headers) }
redirect = (location: string, status: StatusCode = 302): Response => { this._headers ??= new Headers() this._headers.set('Location', location) return this.newResponse(null, status) }
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' }
let onFastly = false try { // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore const { env } = require('fastly:env') if (env instanceof Function) onFastly = true } catch {} if (onFastly) { return 'fastly' }
if (global?.__lagon__ !== undefined) { return 'lagon' }
if (global?.process?.release?.name === 'node') { return 'node' }
return 'other' }}