Class Headers

Hierarchy

Headers

Index

Constructors

Methods

append delete entries forEach get has keys set values

Constructors

constructor

new Headers(init?: HeadersInit): Headers
Create a new instance given initial header values.
Parameters
- Optional init: HeadersInit
  
  initial header values
Returns Headers

Methods

append

append(key: string, value: string): void
Add a value to the list corresponding to a header
Parameters
- key: string
  
  the name of the header
- value: string
  
  the value to add
Returns void

delete

delete(name: string): void
Remove all values for a header
Parameters
- name: string
  
  the name of the header
Returns void

entries

entries(): Generator<[string, string], any, unknown>
Returns Generator<[string, string], any, unknown>

forEach

forEach(func: ((value: unknown, key: unknown, object: unknown) => void), thisValue?: unknown): void
Parameters
- func: ((value: unknown, key: unknown, object: unknown) => void)
  - - (value: unknown, key: unknown, object: unknown): void
    - Parameters
      
      value: unknown
      
      key: unknown
      
      object: unknown
      
      Returns void
- Optional thisValue: unknown
Returns void

get

get(key: string): string
Retrieve a list of header values

Returns
a comma-separated list of values
Parameters
- key: string
  
  the name of the header
Returns string

has

has(name: string): boolean
Check if a value of a header has been set

Returns
true if the header has been set, false otherwise
Parameters
- name: string
  
  the name of the header
Returns boolean

keys

keys(): Generator<string, any, unknown>
Returns Generator<string, any, unknown>

set

set(key: string, value: string): void
Set or override the header value Both the key and the value have a limit of 32767 bytes
Parameters
- key: string
  
  the name of the header
- value: string
  
  the new value
Returns void

values

values(): Generator<string, any, unknown>
Returns Generator<string, any, unknown>