global.Headers
Names are case-insensitive and iterate lowercased, sorted.
Usage
Build request headers.
// Build request headers.
const headers = new Headers({ 'Content-Type': 'application/json' });
headers.append('Accept', 'application/json');
headers.get('content-type'); // 'application/json'
await fetch('https://example.com/api', { headers });Constructors
(init?: HeadersInit): HeadersParameters
| Name | Type | Required | Description |
|---|---|---|---|
init | HeadersInit | No | — |
Returns
Headers
Properties and methods 11
| Name | Type | Required | Description |
|---|---|---|---|
prototypereadonly | Headers | Yes | — |
append | (name: string, value: string) => void | Yes | — |
set | (name: string, value: string) => void | Yes | — |
get | (name: string) => string | null | Yes | A repeated name's values, joined by ", ". |
has | (name: string) => boolean | Yes | — |
delete | (name: string) => void | Yes | — |
forEach | (callback: (value: string, name: string, headers: Headers) => void) => void | Yes | — |
keys | () => string[] | Yes | — |
values | () => string[] | Yes | — |
entries | () => [string, string][] | Yes | — |
__@iterator@1499 | () => IterableIterator<[string, string]> | Yes | — |
append — method signatures
Signatures
(name: string, value: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
value | string | Yes | — |
Returns
void
set — method signatures
Signatures
(name: string, value: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
value | string | Yes | — |
Returns
void
get — method signatures
Signatures
(name: string): string | nullParameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
Returns
string
has — method signatures
Signatures
(name: string): booleanParameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
Returns
boolean
delete — method signatures
Signatures
(name: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
Returns
void
forEach — method signatures
Signatures
(callback: (value: string, name: string, headers: Headers) => void): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
callback | (value: string, name: string, headers: Headers) => void | Yes | — |
Returns
void
keys — method signatures
Signatures
(): string[]Parameters
No parameters.
Returns
string[]
values — method signatures
Signatures
(): string[]Parameters
No parameters.
Returns
string[]
entries — method signatures
Signatures
(): [string, string][]Parameters
No parameters.
Returns
[string, string][]
__@iterator@1499 — method signatures
Signatures
(): IterableIterator<[string, string]>Parameters
No parameters.
Returns
IterableIterator<[string, string]>
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.