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() (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence.

Constructors

constructor

Methods

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

Constructors

constructor

  • new Headers(init?): Headers

  • Parameters

    Returns Headers

Methods

[iterator]

  • [iterator](): IterableIterator<[string, string], any, any>

  • Returns IterableIterator<[string, string], any, any>

append

  • append(name, value): void

  • Parameters

    • name: string
    • value: string

    Returns void

delete

  • delete(name): void

  • Parameters

    • name: string

    Returns void

entries

  • entries(): IterableIterator<[string, string], any, any>

  • Returns an iterator allowing to go through all key/value pairs contained in this object.

    Returns IterableIterator<[string, string], any, any>

forEach

  • forEach(callbackfn, thisArg?): void

  • Parameters

    • callbackfn: ((value: string, key: string, parent: Headers) => void)
        • (value, key, parent): void

        • Parameters

          • value: string
          • key: string
          • parent: Headers

          Returns void

    • OptionalthisArg: any

    Returns void

get

  • get(name): null | string

  • Parameters

    • name: string

    Returns null | string

has

  • has(name): boolean

  • Parameters

    • name: string

    Returns boolean

keys

  • keys(): IterableIterator<string, any, any>

  • Returns an iterator allowing to go through all keys of the key/value pairs contained in this object.

    Returns IterableIterator<string, any, any>

raw

  • raw(): Record<string, string[]>

  • Node-fetch extension

    Returns Record<string, string[]>

set

  • set(name, value): void

  • Parameters

    • name: string
    • value: string

    Returns void

values

  • values(): IterableIterator<string, any, any>

  • Returns an iterator allowing to go through all values of the key/value pairs contained in this object.

    Returns IterableIterator<string, any, any>

Settings

Member Visibility

On This Page

Constructors
Methods