Class HeaderMap

Represents a case-insensitive map for HTTP headers, allowing insertion, appending, removal, clearing, and extending of key-value pairs.

It extends ReadonlyHeaderMap and adds mutable operations.

Hierarchy (View Summary)

ReadonlyHeaderMap
- HeaderMap

Index

Constructors

Properties

Methods

[iterator] append clear containsKey entries extend get getAll insert isEmpty keys len remove toOwned values fromIncomingMessage

Constructors

constructor

new HeaderMap(map?: ReadonlyHeaderMap | Map<string, string[]>): HeaderMap
Parameters
- Optionalmap: ReadonlyHeaderMap | Map<string, string[]>
Returns HeaderMap
Inherited from ReadonlyHeaderMap.constructor
- Defined in http/headers.ts:12

Properties

`Protected` `Readonly`map

map: Map<string, string[]>

Methods

[iterator]

"[iterator]"(): IterableIterator<[string, string], any, any>
Returns IterableIterator<[string, string], any, any>
Inherited from ReadonlyHeaderMap.[iterator]
- Defined in http/headers.ts:82

append

append(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
- Defined in http/headers.ts:98

clear

clear(): void
Returns void
- Defined in http/headers.ts:117

containsKey

containsKey(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from ReadonlyHeaderMap.containsKey
- Defined in http/headers.ts:40

entries

entries(): IterableIterator<[string, string]>
Returns IterableIterator<[string, string]>
Inherited from ReadonlyHeaderMap.entries
- Defined in http/headers.ts:74

extend

extend(items: Iterable<[string, string]>): void
Parameters
- items: Iterable<[string, string]>
Returns void
- Defined in http/headers.ts:121

get

get(key: string): null | string
Parameters
- key: string
Returns null | string
Inherited from ReadonlyHeaderMap.get
- Defined in http/headers.ts:44

getAll

getAll(key: string): readonly string[]
Parameters
- key: string
Returns readonly string[]
Inherited from ReadonlyHeaderMap.getAll
- Defined in http/headers.ts:54

insert

insert(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
- Defined in http/headers.ts:94

isEmpty

isEmpty(): boolean
Returns boolean
Inherited from ReadonlyHeaderMap.isEmpty
- Defined in http/headers.ts:32

keys

keys(): IterableIterator<string>
Returns IterableIterator<string>
Inherited from ReadonlyHeaderMap.keys
- Defined in http/headers.ts:62

len

len(): number
Returns number
Inherited from ReadonlyHeaderMap.len
- Defined in http/headers.ts:36

remove

remove(key: string): null | string
Parameters
- key: string
Returns null | string
- Defined in http/headers.ts:110

toOwned

toOwned(): HeaderMap
Returns HeaderMap
Inherited from ReadonlyHeaderMap.toOwned
- Defined in http/headers.ts:58

values

values(): IterableIterator<string>
Returns IterableIterator<string>
Inherited from ReadonlyHeaderMap.values
- Defined in http/headers.ts:66

`Static`fromIncomingMessage

fromIncomingMessage(message: IncomingMessage): HeaderMap
Parameters
- message: IncomingMessage
Returns HeaderMap
Inherited from ReadonlyHeaderMap.fromIncomingMessage
- Defined in http/headers.ts:26