class Headers

Supported only in the v8 engine. Introduced in Max v9.2.0.

A case-insensitive multimap of HTTP headers.

Index

Constructors

Methods

new Headers(init)

new Headers(init?: HeadersInit);

Constructs a new instance of the Headers class

ParameterTypeDescription
optional initHeadersInitinitial headers.

append(name, value)

Appends a value to a header, preserving existing values.

append(name: string, value: string): void;
NameTypeDescription
namestring
valuestring

delete(name)

Removes a header.

delete(name: string): void;
NameTypeDescription
namestring

entries()

Iterates [name, value] pairs.

entries(): IterableIterator<[string, string]>;
NameTypeDescription
Return ValueIterableIterator<[string, string]>

forEach(callback)

Invokes a callback for each header.

forEach(
  callback: (value: string, name: string, parent: Headers) => void,
): void;
NameTypeDescription
callback(value: string, name: string, parent: Headers) => void

get(name)

Returns the combined value for a header, or null.

get(name: string): string | null;
NameTypeDescription
namestring
Return Valuestring | null

has(name)

Returns whether a header is present.

has(name: string): boolean;
NameTypeDescription
namestring
Return Valueboolean

keys()

Iterates header names.

keys(): IterableIterator<string>;
NameTypeDescription
Return ValueIterableIterator<string>

set(name, value)

Sets a header, replacing any existing value.

set(name: string, value: string): void;
NameTypeDescription
namestring
valuestring

values()

Iterates header values.

values(): IterableIterator<string>;
NameTypeDescription
Return ValueIterableIterator<string>