Class BunRequest

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

auth

csrfToken

isAuthenticated

isUnauthenticated

locals

login

logout

session

sessionID

sessionStore

timedout

user

app

• get app(): RequestAppContext | undefined

  Returns RequestAppContext | undefined

baseUrl

• get baseUrl(): string

  Returns string

• set baseUrl(value: string): void

  Parameters

  • value: string

  Returns void

body

• get body(): unknown

  Returns unknown

• set body(value: unknown): void

  Parameters

  • value: unknown

  Returns void

cookies

• get cookies(): Record<string, string>

  Returns Record<string, string>

• set cookies(value: Record<string, string>): void

  Parameters

  • value: Record<string, string>

  Returns void

file

• get file(): UploadedFile | null

  Returns UploadedFile | null

• set file(value: UploadedFile | null): void

  Parameters

  • value: UploadedFile | null

  Returns void

files

• get files(): UploadedFile[] | Record<string, UploadedFile[]> | null

  Returns UploadedFile[] | Record<string, UploadedFile[]> | null

• set files(value: UploadedFile[] | Record<string, UploadedFile[]> | null): void

  Parameters

  • value: UploadedFile[] | Record<string, UploadedFile[]> | null

  Returns void

fresh

• get fresh(): boolean

  Returns boolean

headers

• get headers(): Headers

  Returns Headers

hostname

• get hostname(): string

  Returns string

ip

• get ip(): string

  Returns string

ips

• get ips(): string[]

  Returns string[]

method

• get method(): string

  Returns string

original

• get original(): Request

  Returns Request

originalUrl

• get originalUrl(): string

  Returns string

params

• get params(): Record<string, string>

  Returns Record<string, string>

• set params(value: Record<string, string>): void

  Parameters

  • value: Record<string, string>

  Returns void

path

• get path(): string

  Returns string

pathname

• get pathname(): string

  Returns string

protocol

• get protocol(): string

  Returns string

query

• get query(): URLSearchParams & Record<string, string | string[]>

  Returns URLSearchParams & Record<string, string | string[]>

res

• get res(): BunResponse | undefined

  Returns BunResponse | undefined

route

• get route(): { method: string; path: string } | null

  Returns { method: string; path: string } | null

• set route(value: { method: string; path: string } | null): void

  Parameters

  • value: { method: string; path: string } | null

  Returns void

secret

• get secret(): string | undefined

  Returns string | undefined

• set secret(value: string | undefined): void

  Parameters

  • value: string | undefined

  Returns void

secure

• get secure(): boolean

  Returns boolean

signedCookies

• get signedCookies(): Record<string, string | false>

  Returns Record<string, string | false>

• set signedCookies(value: Record<string, string | false>): void

  Parameters

  • value: Record<string, string | false>

  Returns void

stale

• get stale(): boolean

  Returns boolean

subdomains

• get subdomains(): string[]

  Returns string[]

url

• get url(): string

  Returns string

xhr

• get xhr(): boolean

  Returns boolean

accepts

• accepts(...types: string[]): string | false

  Parameters

  • ...types: string[]

  Returns string | false

acceptsCharsets

• acceptsCharsets(...charsets: string[]): string | false

  Parameters

  • ...charsets: string[]

  Returns string | false

acceptsEncodings

• acceptsEncodings(...encodings: string[]): string | false

  Parameters

  • ...encodings: string[]

  Returns string | false

acceptsLanguages

• acceptsLanguages(...languages: string[]): string | false

  Parameters

  • ...languages: string[]

  Returns string | false

get

• get(header: string): string | undefined

  Parameters

  • header: string

  Returns string | undefined

header

• header(name: string): string | undefined

  Parameters

  • name: string

  Returns string | undefined

is

• is(...types: string[]): string | false

  Parameters

  • ...types: string[]

  Returns string | false

isBodyParsed

• isBodyParsed(): boolean

  Returns boolean

param

• param(name: string): string | undefined

  Parameters

  • name: string

  Returns string | undefined

parseJson

• parseJson(limit?: number): Promise<unknown>

  Parameters

  • limit: number = DEFAULT_BODY_LIMIT

  Returns Promise<unknown>

parseText

• parseText(limit?: number): Promise<string>

  Parameters

  • limit: number = DEFAULT_BODY_LIMIT

  Returns Promise<string>

parseUrlencoded

• parseUrlencoded(limit?: number): Promise<Record<string, string>>

  Parameters

  • limit: number = DEFAULT_BODY_LIMIT

  Returns Promise<Record<string, string>>

range

• range(size: number, options?: { combine?: boolean }): RangeResult | undefined

  Parameters

  • size: number
  • Optionaloptions: { combine?: boolean }

  Returns RangeResult | undefined

rawBody

• rawBody(): Promise<Uint8Array<ArrayBufferLike>>

  Returns Promise<Uint8Array<ArrayBufferLike>>

rawText

• rawText(): Promise<string>

  Returns Promise<string>

setApp

• setApp(app: RequestAppContext): void

  Parameters

  • app: RequestAppContext

  Returns void

setBaseUrl

• setBaseUrl(baseUrl: string): void

  Parameters

  • baseUrl: string

  Returns void

setRes

• setRes(res: BunResponse): void

  Parameters

  • res: BunResponse

  Returns void

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