class Headers
Supported only in the v8 engine. Introduced in Max v9.2.0.
A case-insensitive multimap of HTTP headers.
Index
Constructors
Methods
- append(name, value)
- delete(name)
- entries()
- forEach(callback)
- get(name)
- has(name)
- keys()
- set(name, value)
- values()
new Headers(init)
new Headers(init?: HeadersInit);
Constructs a new instance of the Headers class
| Parameter | Type | Description |
|---|---|---|
| optional init | HeadersInit | initial headers. |
append(name, value)
Appends a value to a header, preserving existing values.
append(name: string, value: string): void;
| Name | Type | Description |
|---|---|---|
| name | string | |
| value | string |
delete(name)
Removes a header.
delete(name: string): void;
| Name | Type | Description |
|---|---|---|
| name | string |
entries()
Iterates [name, value] pairs.
entries(): IterableIterator<[string, string]>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<[string, string]> |
forEach(callback)
Invokes a callback for each header.
forEach(
callback: (value: string, name: string, parent: Headers) => void,
): void;
| Name | Type | Description |
|---|---|---|
| callback | (value: string, name: string, parent: Headers) => void |
get(name)
Returns the combined value for a header, or null.
get(name: string): string | null;
| Name | Type | Description |
|---|---|---|
| name | string | |
| Return Value | string | null |
has(name)
Returns whether a header is present.
has(name: string): boolean;
| Name | Type | Description |
|---|---|---|
| name | string | |
| Return Value | boolean |
keys()
Iterates header names.
keys(): IterableIterator<string>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<string> |
set(name, value)
Sets a header, replacing any existing value.
set(name: string, value: string): void;
| Name | Type | Description |
|---|---|---|
| name | string | |
| value | string |
values()
Iterates header values.
values(): IterableIterator<string>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<string> |