Class BunResponse

constructor

• new BunResponse(): BunResponse

  Returns BunResponse

locals

app

• get app(): AppContext | undefined

  Returns AppContext | undefined

headersSent

• get headersSent(): boolean

  Returns boolean

req

• get req(): BunRequest | undefined

  Returns BunRequest | undefined

statusCode

• get statusCode(): number

  Returns number

append

• append(name: string, value: string): this

  Parameters

  • name: string
  • value: string

  Returns this

attachment

• attachment(filename?: string): this

  Parameters

  • Optionalfilename: string

  Returns this

badRequest

• badRequest(message?: string): void

  Parameters

  • message: string = "Bad Request"

  Returns void

clearCookie

• clearCookie(name: string, options?: CookieOptions): this

  Parameters

  • name: string
  • options: CookieOptions = {}

  Returns this

contentType

• contentType(type: string): this

  Parameters

  • type: string

  Returns this

cookie

• cookie(name: string, value: string, options?: CookieOptions): this

  Parameters

  • name: string
  • value: string
  • options: CookieOptions = {}

  Returns this

created

• created(data?: unknown): void

  Parameters

  • Optionaldata: unknown

  Returns void

download

• download(
      filePath: string,
      filename?: string,
      options?: SendFileOptions | ((err?: Error) => void),
      callback?: (err?: Error) => void,
  ): Promise<void>

  Parameters

  • filePath: string
  • Optionalfilename: string
  • Optionaloptions: SendFileOptions | ((err?: Error) => void)
  • Optionalcallback: (err?: Error) => void

  Returns Promise<void>

end

• end(
      chunk?: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
      encoding?: string | (() => void),
      callback?: () => void,
  ): void

  End the response stream (Express-compatible). Optionally write final data before closing.

  Parameters

  • Optionalchunk: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
  • Optionalencoding: string | (() => void)
  • Optionalcallback: () => void

  Returns void

  Example

  res.end(); // Just close
  res.end('Final chunk'); // Write and close
  Copy

flushHeaders

• flushHeaders(): void

  Flush the response headers immediately (Express-compatible). Useful for SSE or when you want headers sent before body.

  Returns void

forbidden

• forbidden(message?: string): void

  Parameters

  • message: string = "Forbidden"

  Returns void

format

• format(handlers: FormatHandlers): void

  Parameters

  • handlers: FormatHandlers

  Returns void

get

• get(name: string): string | undefined

  Parameters

  • name: string

  Returns string | undefined

getHeaders

• getHeaders(): Headers

  Returns Headers

getStream

• getStream(): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>> | null

  Get the stream promise for streaming responses

  Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>> | null

header

• header(name: string, value: string): this

  Parameters

  • name: string
  • value: string

  Returns this

html

• html(data: string): void

  Parameters

  • data: string

  Returns void

isSent

• isSent(): boolean

  Returns boolean

isStreaming

• isStreaming(): boolean

  Check if response is in streaming mode

  Returns boolean

json

• json(data: unknown): this

  Parameters

  • data: unknown

  Returns this

jsonp

• jsonp(data: unknown): void

  Parameters

  • data: unknown

  Returns void

links

• links(links: Record<string, string>): this

  Parameters

  • links: Record<string, string>

  Returns this

location

• location(url: string): this

  Parameters

  • url: string

  Returns this

noContent

• noContent(): void

  Returns void

notFound

• notFound(message?: string): void

  Parameters

  • message: string = "Not Found"

  Returns void

ok

• ok(data?: unknown): void

  Parameters

  • Optionaldata: unknown

  Returns void

redirect

• redirect(urlOrStatus: string | number, url?: string): void

  Parameters

  • urlOrStatus: string | number
  • Optionalurl: string

  Returns void

render

• render(
      view: string,
      options?: RenderOptions,
      callback?: (err: Error | null, html?: string) => void,
  ): Promise<void>

  Parameters

  • view: string
  • Optionaloptions: RenderOptions
  • Optionalcallback: (err: Error | null, html?: string) => void

  Returns Promise<void>

send

• send(body?: unknown): this

  Parameters

  • Optionalbody: unknown

  Returns this

sendFile

• sendFile(filePath: string, options?: SendFileOptions): Promise<void>

  Parameters

  • filePath: string
  • Optionaloptions: SendFileOptions

  Returns Promise<void>

• sendFile(filePath: string, callback: (err?: Error) => void): Promise<void>

  Parameters

  • filePath: string
  • callback: (err?: Error) => void

  Returns Promise<void>

• sendFile(
      filePath: string,
      options: SendFileOptions,
      callback: (err?: Error) => void,
  ): Promise<void>

  Parameters

  • filePath: string
  • options: SendFileOptions
  • callback: (err?: Error) => void

  Returns Promise<void>

sendStatus

• sendStatus(code: number): void

  Parameters

  • code: number

  Returns void

set

• set(name: string, value: string): this

  Parameters

  • name: string
  • value: string

  Returns this

setAcceptHeader

• setAcceptHeader(accept: string | undefined): void

  Parameters

  • accept: string | undefined

  Returns void

setApp

• setApp(app: AppContext): void

  Parameters

  • app: AppContext

  Returns void

setReq

• setReq(req: BunRequest): void

  Parameters

  • req: BunRequest

  Returns void

status

• status(code: number): this

  Parameters

  • code: number

  Returns this

text

• text(data: string): void

  Parameters

  • data: string

  Returns void

toResponse

• toResponse(): Response

  Returns Response

toStreamingResponse

• toStreamingResponse(): Promise<Response>

  Create a streaming response. Used internally by the router.

  Returns Promise<Response>

type

• type(mimeType: string): this

  Parameters

  • mimeType: string

  Returns this

unauthorized

• unauthorized(message?: string): void

  Parameters

  • message: string = "Unauthorized"

  Returns void

vary

• vary(field: string | string[]): this

  Parameters

  • field: string | string[]

  Returns this

write

• write(chunk: string | ArrayBuffer | Uint8Array<ArrayBufferLike>): boolean

  Write a chunk to the response stream (Express-compatible). This enables streaming responses for large data.

  Parameters

  • chunk: string | ArrayBuffer | Uint8Array<ArrayBufferLike>

  Returns boolean

  Example

  app.get('/stream', (req, res) => {
    res.set('Content-Type', 'text/plain');
    res.write('Hello ');
    res.write('World');
    res.end('!');
  });
  Copy