Class Headers

This Fetch API interface allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing.

A Headers object has an associated header list, which is initially empty and consists of zero or more name and value pairs. You can add to this using methods like append(). In all methods of this interface, header names are matched by case-insensitive byte sequence.

MDN Reference

Hierarchy

Headers

Implements

Headers

Index

Constructors

constructor

Methods

[iterator] append delete entries forEach get getSetCookie has keys set values

Constructors

constructor

new Headers(init?): Headers
Parameters
- Optional init: HeadersInit
Returns Headers
- Defined in packages/runtime/src/fetch/headers.ts:20

Methods

[iterator]

[iterator](): IterableIterator<[string, string]>
Same as entries().

Returns IterableIterator<[string, string]>
Implementation of globalThis.Headers.[iterator]
- Defined in packages/runtime/src/fetch/headers.ts:129

append

append(name, value): void
MDN Reference
Parameters
- name: string
- value: string
Returns void
Implementation of globalThis.Headers.append
- Defined in packages/runtime/src/fetch/headers.ts:44

delete

delete(name): void
MDN Reference
Parameters
- name: string
Returns void
Implementation of globalThis.Headers.delete
- Defined in packages/runtime/src/fetch/headers.ts:57

entries

entries(): IterableIterator<[string, string]>
Returns an iterator allowing to go through all key/value pairs contained in this object.

Returns IterableIterator<[string, string]>
Implementation of globalThis.Headers.entries
- Defined in packages/runtime/src/fetch/headers.ts:99

forEach

forEach(callbackfn, thisArg?): void
Parameters
- callbackfn: ((value, key, parent) => void)
  - - (value, key, parent): void
    - Parameters
      
      value: string
      
      key: string
      
      parent: Headers
      
      Returns void
- Optional thisArg: any
Returns void
Implementation of globalThis.Headers.forEach
- Defined in packages/runtime/src/fetch/headers.ts:88

get

get(name): null | string
MDN Reference
Parameters
- name: string
Returns null | string
Implementation of globalThis.Headers.get
- Defined in packages/runtime/src/fetch/headers.ts:63

getSetCookie

getSetCookie(): string[]
MDN Reference

Returns string[]
- Defined in packages/runtime/src/fetch/headers.ts:71

has

has(name): boolean
MDN Reference
Parameters
- name: string
Returns boolean
Implementation of globalThis.Headers.has
- Defined in packages/runtime/src/fetch/headers.ts:77

keys

keys(): IterableIterator<string>
Returns an iterator allowing to go through all keys of the key/value pairs contained in this object.

Returns IterableIterator<string>
Implementation of globalThis.Headers.keys
- Defined in packages/runtime/src/fetch/headers.ts:113

set

set(name, value): void
MDN Reference
Parameters
- name: string
- value: string
Returns void
Implementation of globalThis.Headers.set
- Defined in packages/runtime/src/fetch/headers.ts:83

values

values(): IterableIterator<string>
Returns an iterator allowing to go through all values of the key/value pairs contained in this object.

Returns IterableIterator<string>
Implementation of globalThis.Headers.values
- Defined in packages/runtime/src/fetch/headers.ts:120

Class Headers

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional init: HeadersInit

Returns Headers

Methods

[iterator]

Returns IterableIterator<[string, string]>

append

Parameters

name: string

value: string

Returns void

delete

Parameters

name: string

Returns void

entries

Returns IterableIterator<[string, string]>

forEach

Parameters

callbackfn: ((value, key, parent) => void)

Parameters

value: string

key: string

parent: Headers

Returns void

Optional thisArg: any

Returns void

get

Parameters

name: string

Returns null | string

getSetCookie

Returns string[]

has

Parameters

name: string

Returns boolean

keys

Returns IterableIterator<string>

set

Parameters

name: string

value: string

Returns void

values

Returns IterableIterator<string>

Settings

Member Visibility

Theme

On This Page

`Optional` init: HeadersInit

`Optional` thisArg: any