Class HttpHeadersWrap

Wrapper class for HTTP message headers.

Constructors

constructor

new HttpHeadersWrap(headers: HttpHeaders): HttpHeadersWrap
Creates a new wrapper instance.
Parameters
- headers: HttpHeaders
  The headers object to wrap.
Returns HttpHeadersWrap

Accessors

isFrozen

get isFrozen(): boolean

Checks if the wrapper is frozen (read-only).

Returns boolean
true if the wrapper is frozen, false otherwise.

length

get length(): number

Gets the number of headers.

Returns number
The number of headers in the object.

Methods

add

add(name: string, value: string): this
Appends a value to an existing header or creates a new one.
Parameters
- name: string
  The header name (case-insensitive).
- value: string
  The value to append.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

clone

clone(): HttpHeadersWrap

Clones the wrapper with a copy of the headers.

Returns HttpHeadersWrap
A new independent wrapper instance.

delete

delete(arg: string | string[]): this
Deletes one or more headers.
Parameters
- arg: string | string[]
  The single header name or the array of names to delete.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

entries

entries(): [string, HttpHeader][]

Gets the headers as an array of entries.

Returns [string, HttpHeader][]
The array of [name, value] pairs.

forEach

forEach(cb: (name: string, value: HttpHeader) => void): this
Iterates over all headers.
Parameters
- cb: (name: string, value: HttpHeader) => void
  The callback function to call for each header.
Returns this
This wrapper for method chaining.

freeze

freeze(): this

Freezes the wrapper to prevent modifications.

Returns this
This wrapper for method chaining.

get

get(name: string): HttpHeader | undefined
Gets a header value as a string or array of strings.
Parameters
- name: string
  The header name (case-insensitive).
Returns HttpHeader | undefined
The header value, or undefined if the header does not exist.

getArray

getArray(name: string): string[] | undefined
Gets a header value as an array of strings.
Parameters
- name: string
  The header name (case-insensitive).
Returns string[] | undefined
The header values as an array, or undefined if the header does not exist.

getContentType

getContentType(): HttpContentType | null

Gets the Content-Type header as a parsed object (cached).

Returns HttpContentType | null
The parsed Content-Type object, or null if the header is not present.

Throws
Error If Content-Type parsing fails.

getCookies

getCookies(): HttpCookies | null

Gets the Cookie header as a parsed object (cached).

Returns HttpCookies | null
The parsed cookies object, or null if the header is not present.

getSetCookies

getSetCookies(): HttpSetCookies | null

Gets the Set-Cookie header as a parsed object (cached).

Returns HttpSetCookies | null
The parsed Set-Cookie object, or null if the header is not present.

getString

getString(name: string): string | undefined
Gets a header value as a single string.
Parameters
- name: string
  The header name (case-insensitive).
Returns string | undefined
The first header value, or undefined if the header does not exist.

has

has(name: string): boolean
Checks if a header exists.
Parameters
- name: string
  The header name (case-insensitive).
Returns boolean
true if the header exists, false otherwise.

merge

merge(headers: HttpHeaders): this
Merges headers from another object.
Parameters
- headers: HttpHeaders
  The headers object to merge from.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

reset

reset(): this

Clears all headers and resets to an empty state.

Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

set

set(name: string, value: HttpHeader): this
Sets a header value.
Parameters
- name: string
  The header name (case-insensitive).
- value: HttpHeader
  The new header value.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

setContentType

setContentType(contentType: HttpContentType): this
Sets the Content-Type header from an object.
Parameters
- contentType: HttpContentType
  The Content-Type object.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

Throws
Error If Content-Type formatting fails.

setCookies

setCookies(cookies: HttpCookies): this
Sets the Cookie header from an object.
Parameters
- cookies: HttpCookies
  The cookies object.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

setSetCookies

setSetCookies(setCookies: HttpSetCookies): this
Sets the Set-Cookie header from an object.
Parameters
- setCookies: HttpSetCookies
  The Set-Cookie object.
Returns this
This wrapper for method chaining.

Throws
Error If the wrapper is frozen.

toObject

toObject(): HttpStrictHeaders

Gets the headers as a strict headers object.

Returns HttpStrictHeaders
A copy of the headers object with all undefined values removed.

`Static`fromReq

fromReq(req: { headers: HttpHeaders }): HttpHeadersWrap
Factory method to create a wrapper from a request-like object.
Parameters
- req: { headers: HttpHeaders }
  An object with a headers property.
Returns HttpHeadersWrap
A new wrapper instance.

`Static`fromScratch

fromScratch(): HttpHeadersWrap

Factory method to create a wrapper from scratch.

Returns HttpHeadersWrap
A new wrapper instance with empty headers.