Skip to main content

Class: Headers

Defined in: src/http/headers.ts:23

Headers - Case-insensitive HTTP headers container

Stores headers with lowercase keys internally but preserves original case for output. Supports multiple values per header.

Implements​

  • Iterable<[string, string]>

Constructors​

Constructor​

new Headers(init?): Headers

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

Parameters​

init?​

HeadersInit

Returns​

Headers

Accessors​

size​

Get Signature​

get size(): number

Defined in: src/http/headers.ts:203

Get the number of unique header names

Returns​

number

Methods​

[iterator]()​

[iterator](): IterableIterator<[string, string]>

Defined in: src/http/headers.ts:113

Iterate over all headers (same as entries)

Returns​

IterableIterator<[string, string]>

Implementation of​

Iterable.[iterator]

append()​

append(name, value): void

Defined in: src/http/headers.ts:59

Append a value to a header (allows multiple values)

Parameters​

name​

string

value​

string

Returns​

void

clone()​

clone(): Headers

Defined in: src/http/headers.ts:321

Create a copy of these headers

Returns​

Headers

delete()​

delete(name): boolean

Defined in: src/http/headers.ts:69

Delete a header

Parameters​

name​

string

Returns​

boolean

entries()​

entries(): IterableIterator<[string, string]>

Defined in: src/http/headers.ts:102

Iterate over all header entries For headers with multiple values, yields each value separately

Returns​

IterableIterator<[string, string]>

extend()​

extend(init): void

Defined in: src/http/headers.ts:129

Extend headers from another source

Parameters​

init​

HeadersInit

Returns​

void

forEach()​

forEach(callback): void

Defined in: src/http/headers.ts:120

Execute a callback for each header

Parameters​

callback​

(value, name, headers) => void

Returns​

void

get()​

get(name): string | null

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

Get the first value for a header

Parameters​

name​

string

Returns​

string | null

getAll()​

getAll(name): string[]

Defined in: src/http/headers.ts:44

Get all values for a header

Parameters​

name​

string

Returns​

string[]

has()​

has(name): boolean

Defined in: src/http/headers.ts:76

Check if a header exists

Parameters​

name​

string

Returns​

boolean

keys()​

keys(): IterableIterator<string>

Defined in: src/http/headers.ts:83

Get all header names (lowercase)

Returns​

IterableIterator<string>

set()​

set(name, value): void

Defined in: src/http/headers.ts:52

Set a header, replacing any existing values

Parameters​

name​

string

value​

string

Returns​

void

toCurlHeaders()​

toCurlHeaders(): string[]

Defined in: src/http/headers.ts:165

Convert to curl header format: ["Header-Name: value", ...]

Returns​

string[]

toMultiObject()​

toMultiObject(): Record<string, string[]>

Defined in: src/http/headers.ts:189

Convert to a plain object with all values

Returns​

Record<string, string[]>

toObject()​

toObject(): Record<string, string>

Defined in: src/http/headers.ts:176

Convert to a plain object (first value per header)

Returns​

Record<string, string>

toString()​

toString(): string

Defined in: src/http/headers.ts:332

String representation

Returns​

string

values()​

values(): IterableIterator<string>

Defined in: src/http/headers.ts:90

Get all header values (first value per header)

Returns​

IterableIterator<string>

fromRaw()​

static fromRaw(raw): Headers

Defined in: src/http/headers.ts:284

Create Headers from curl response headers Parses raw header lines (including status line)

Parameters​

raw​

string | Buffer

Returns​

Headers

parseHeaderValue()​

static parseHeaderValue(value): string[]

Defined in: src/http/headers.ts:293

Parse a single Set-Cookie or other multi-value header

Parameters​

value​

string

Returns​

string[]

splitRawByResponse()​

static splitRawByResponse(raw): HeaderSegment[]

Defined in: src/http/headers.ts:212

Split raw headers buffer into per-response segments. When curl follows redirects, the header callback receives headers for every response in the chain. Each HTTP/ status line starts a new segment.

Parameters​

raw​

string | Buffer

Returns​

HeaderSegment[]