Skip to main content

Class: Response

Defined in: src/http/response.ts:27

Response - HTTP response with headers, cookies, and body

Constructors​

Constructor​

new Response(init): Response

Defined in: src/http/response.ts:61

Parameters​

init​

ResponseInit

Returns​

Response

Properties​

contentType​

readonly contentType: string | null

Defined in: src/http/response.ts:50

cookies​

readonly cookies: Cookies

Defined in: src/http/response.ts:35

elapsed​

readonly elapsed: number

Defined in: src/http/response.ts:36

headers​

readonly headers: Headers

Defined in: src/http/response.ts:34

history​

readonly history: Response[]

Defined in: src/http/response.ts:53

httpVersion​

readonly httpVersion: number

Defined in: src/http/response.ts:49

localIp​

readonly localIp: string | null

Defined in: src/http/response.ts:39

localPort​

readonly localPort: number

Defined in: src/http/response.ts:40

primaryIp​

readonly primaryIp: string | null

Defined in: src/http/response.ts:37

primaryPort​

readonly primaryPort: number

Defined in: src/http/response.ts:38

redirectCount​

readonly redirectCount: number

Defined in: src/http/response.ts:41

redirectUrl​

readonly redirectUrl: string | null

Defined in: src/http/response.ts:48

URL of the next redirect that was NOT followed, or null if all redirects were followed. When allowRedirects is true (default), this will be null after a successful redirect chain. Use response.url for the final URL, or response.history for intermediate Response objects at each redirect step.

requestUrl​

readonly requestUrl: string

Defined in: src/http/response.ts:29

statusCode​

readonly statusCode: number

Defined in: src/http/response.ts:33

url​

readonly url: string

Defined in: src/http/response.ts:32

Accessors​

content​

Get Signature​

get content(): Buffer

Defined in: src/http/response.ts:224

Get response body as Buffer (sync) Throws if content is not available (streaming response)

Returns​

Buffer

encoding​

Get Signature​

get encoding(): string

Defined in: src/http/response.ts:188

Get response encoding

Returns​

string

Set Signature​

set encoding(value): void

Defined in: src/http/response.ts:195

Set response encoding

Parameters​
value​

string

Returns​

void

httpVersionString​

Get Signature​

get httpVersionString(): string

Defined in: src/http/response.ts:202

Get HTTP version as string

Returns​

string

ok​

Get Signature​

get ok(): boolean

Defined in: src/http/response.ts:174

Check if response was successful (2xx status)

Returns​

boolean

reason​

Get Signature​

get reason(): string

Defined in: src/http/response.ts:181

Get status reason phrase

Returns​

string

status​

Get Signature​

get status(): number

Defined in: src/http/response.ts:160

HTTP status code (alias for statusCode)

Returns​

number

statusText​

Get Signature​

get statusText(): string

Defined in: src/http/response.ts:167

HTTP status reason phrase (alias for reason)

Returns​

string

text​

Get Signature​

get text(): string

Defined in: src/http/response.ts:237

Get response body as string (sync)

Returns​

string

Methods​

aClose()​

aClose(): Promise<void>

Defined in: src/http/response.ts:359

Alias for close

Returns​

Promise<void>

aContent()​

aContent(): Promise<Buffer>

Defined in: src/http/response.ts:260

Async content getter

Returns​

Promise<Buffer>

aJson()​

aJson<T>(): Promise<T>

Defined in: src/http/response.ts:288

Async JSON parser

Type Parameters​

T​

T = unknown

Returns​

Promise<T>

aText()​

aText(): Promise<string>

Defined in: src/http/response.ts:280

Async text getter

Returns​

Promise<string>

close()​

close(): Promise<void>

Defined in: src/http/response.ts:351

Close the response (cleanup resources)

Returns​

Promise<void>

iterContent()​

iterContent(chunkSize?): AsyncIterableIterator<Buffer>

Defined in: src/http/response.ts:296

Iterate over response content in chunks

Parameters​

chunkSize?​

number

Returns​

AsyncIterableIterator<Buffer>

iterLines()​

iterLines(delimiter?, keepEnds?): AsyncIterableIterator<string>

Defined in: src/http/response.ts:313

Iterate over response content line by line

Parameters​

delimiter?​

string = "\n"

keepEnds?​

boolean = false

Returns​

AsyncIterableIterator<string>

json()​

json<T>(): T

Defined in: src/http/response.ts:244

Parse response body as JSON (sync)

Type Parameters​

T​

T = unknown

Returns​

T

raiseForStatus()​

raiseForStatus(): void

Defined in: src/http/response.ts:251

Raise an exception if status code indicates an error

Returns​

void

setContent()​

setContent(content): void

Defined in: src/http/response.ts:344

Set the response content directly

Parameters​

content​

Buffer

Returns​

void

setStream()​

setStream(stream): void

Defined in: src/http/response.ts:337

Set the response stream (for streaming responses)

Parameters​

stream​

AsyncIterable<Buffer>

Returns​

void