Class BunRequest

Index

Constructors

Properties

locals timedout

Accessors

app baseUrl body cookies file files fresh headers hostname ip ips method original originalUrl params path pathname protocol query res route secure signedCookies stale subdomains url xhr

Methods

accepts acceptsCharsets acceptsEncodings acceptsLanguages get header is isBodyParsed param parseJson parseText parseUrlencoded range rawBody rawText setApp setRes setSocketIp

Constructors

constructor

new BunRequest(original: Request, pathname?: string): BunRequest
Create a new BunRequest.
Parameters
- original: Request
  The original Request object
- Optionalpathname: string
  Optional pre-computed pathname (avoids URL parsing)
Returns BunRequest
- Defined in src/core/request.ts:93

Properties

locals

locals: Record<string, unknown> = {}

timedout

timedout: boolean = false

Accessors

app

get app(): RequestAppContext | undefined
Returns RequestAppContext | undefined
- Defined in src/core/request.ts:149

baseUrl

get baseUrl(): string
Returns string
- Defined in src/core/request.ts:294
set baseUrl(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/request.ts:298

body

get body(): unknown
Returns unknown
- Defined in src/core/request.ts:267
set body(value: unknown): void
Parameters
- value: unknown
Returns void
- Defined in src/core/request.ts:271

cookies

get cookies(): Record<string, string>
Returns Record<string, string>
- Defined in src/core/request.ts:437
set cookies(value: Record<string, string>): void
Parameters
- value: Record<string, string>
Returns void
- Defined in src/core/request.ts:444

file

get file(): UploadedFile | null
Returns UploadedFile | null
- Defined in src/core/request.ts:456
set file(value: UploadedFile | null): void
Parameters
- value: UploadedFile | null
Returns void
- Defined in src/core/request.ts:460

files

get files(): UploadedFile[] | Record<string, UploadedFile[]> | null
Returns UploadedFile[] | Record<string, UploadedFile[]> | null
- Defined in src/core/request.ts:464
set files(value: UploadedFile[] | Record<string, UploadedFile[]> | null): void
Parameters
- value: UploadedFile[] | Record<string, UploadedFile[]> | null
Returns void
- Defined in src/core/request.ts:468

fresh

get fresh(): boolean
Returns boolean
- Defined in src/core/request.ts:326

headers

get headers(): Headers
Returns Headers
- Defined in src/core/request.ts:255

hostname

get hostname(): string
Returns string
- Defined in src/core/request.ts:276

ip

get ip(): string
Returns string
- Defined in src/core/request.ts:374

ips

get ips(): string[]
Returns string[]
- Defined in src/core/request.ts:403

method

get method(): string
Returns string
- Defined in src/core/request.ts:208

original

get original(): Request
Returns Request
- Defined in src/core/request.ts:433

originalUrl

get originalUrl(): string
Returns string
- Defined in src/core/request.ts:224

params

get params(): Record<string, string>
Returns Record<string, string>
- Defined in src/core/request.ts:259
set params(value: Record<string, string>): void
Parameters
- value: Record<string, string>
Returns void
- Defined in src/core/request.ts:263

path

get path(): string
Returns string
- Defined in src/core/request.ts:216

pathname

get pathname(): string
Returns string
- Defined in src/core/request.ts:220

protocol

get protocol(): string
Returns string
- Defined in src/core/request.ts:311

query

get query(): URLSearchParams & Record<string, string | string[]>
Returns URLSearchParams & Record<string, string | string[]>
- Defined in src/core/request.ts:229

res

get res(): BunResponse | undefined
Returns BunResponse | undefined
- Defined in src/core/request.ts:153

route

get route(): { method: string; path: string } | null
Returns { method: string; path: string } | null
- Defined in src/core/request.ts:303
set route(value: { method: string; path: string } | null): void
Parameters
- value: { method: string; path: string } | null
Returns void
- Defined in src/core/request.ts:307

secure

get secure(): boolean
Returns boolean
- Defined in src/core/request.ts:322

signedCookies

get signedCookies(): Record<string, string>
Returns Record<string, string>
- Defined in src/core/request.ts:448
set signedCookies(value: Record<string, string>): void
Parameters
- value: Record<string, string>
Returns void
- Defined in src/core/request.ts:452

stale

get stale(): boolean
Returns boolean
- Defined in src/core/request.ts:370

subdomains

get subdomains(): string[]
Returns string[]
- Defined in src/core/request.ts:280

url

get url(): string
Returns string
- Defined in src/core/request.ts:212

xhr

get xhr(): boolean
Returns boolean
- Defined in src/core/request.ts:428

Methods

accepts

accepts(...types: string[]): string | false
Parameters
- ...types: string[]
Returns string | false
- Defined in src/core/request.ts:522

acceptsCharsets

acceptsCharsets(...charsets: string[]): string | false
Parameters
- ...charsets: string[]
Returns string | false
- Defined in src/core/request.ts:526

acceptsEncodings

acceptsEncodings(...encodings: string[]): string | false
Parameters
- ...encodings: string[]
Returns string | false
- Defined in src/core/request.ts:530

acceptsLanguages

acceptsLanguages(...languages: string[]): string | false
Parameters
- ...languages: string[]
Returns string | false
- Defined in src/core/request.ts:534

get

get(header: string): string | undefined
Parameters
- header: string
Returns string | undefined
- Defined in src/core/request.ts:510

header(name: string): string | undefined
Parameters
- name: string
Returns string | undefined
- Defined in src/core/request.ts:514

is

is(...types: string[]): string | false
Parameters
- ...types: string[]
Returns string | false
- Defined in src/core/request.ts:518

isBodyParsed

isBodyParsed(): boolean
Returns boolean
- Defined in src/core/request.ts:611

param

param(name: string): string | undefined
Parameters
- name: string
Returns string | undefined
- Defined in src/core/request.ts:500

parseJson

parseJson(limit?: number): Promise<unknown>
Parameters
- limit: number = DEFAULT_BODY_LIMIT
Returns Promise<unknown>
- Defined in src/core/request.ts:627

parseText

parseText(limit?: number): Promise<string>
Parameters
- limit: number = DEFAULT_BODY_LIMIT
Returns Promise<string>
- Defined in src/core/request.ts:680

parseUrlencoded

parseUrlencoded(limit?: number): Promise<Record<string, string>>
Parameters
- limit: number = DEFAULT_BODY_LIMIT
Returns Promise<Record<string, string>>
- Defined in src/core/request.ts:667

range

range(size: number, options?: { combine?: boolean }): RangeResult | undefined
Parameters
- size: number
- Optionaloptions: { combine?: boolean }
Returns RangeResult | undefined
- Defined in src/core/request.ts:538

rawBody

rawBody(): Promise<Uint8Array<ArrayBufferLike>>
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in src/core/request.ts:615

rawText

rawText(): Promise<string>
Returns Promise<string>
- Defined in src/core/request.ts:622

setApp

setApp(app: RequestAppContext): void
Parameters
- app: RequestAppContext
Returns void
- Defined in src/core/request.ts:141

setRes

setRes(res: BunResponse): void
Parameters
- res: BunResponse
Returns void
- Defined in src/core/request.ts:145

setSocketIp

setSocketIp(ip: string | null): void
Set the direct socket IP address (from Bun.serve's server.requestIP). This should be called by the server when creating the request.
Parameters
- ip: string | null
Returns void
- Defined in src/core/request.ts:137