Package version:

Interface HttpHeadersLike

A collection of HTTP header key/value pairs.

interface HttpHeadersLike {
    clone(): HttpHeadersLike;
    contains(headerName): boolean;
    get(headerName): undefined | string;
    headerNames(): string[];
    headerValues(): string[];
    headersArray(): HttpHeader[];
    rawHeaders(): RawHttpHeaders;
    remove(headerName): boolean;
    set(headerName, headerValue): void;
    toJson(options?): RawHttpHeaders;
}

Index

Methods

clone contains get headerNames headerValues headersArray rawHeaders remove set toJson

Methods

clone

clone(): HttpHeadersLike
Create a deep clone/copy of this HttpHeaders collection.

Returns HttpHeadersLike
- Defined in util/compat/httpHeaders.ts:77

contains

contains(headerName): boolean
Get whether or not this header collection contains a header entry for the provided header name.
Parameters
- headerName: string
Returns boolean
- Defined in util/compat/httpHeaders.ts:51

get

get(headerName): undefined | string
Get the header value for the provided header name, or undefined if no header exists in this collection with the provided name.
Parameters
- headerName: string
  The name of the header.
Returns undefined | string
- Defined in util/compat/httpHeaders.ts:47

headerNames

headerNames(): string[]
Get the header names that are contained in this collection.

Returns string[]
- Defined in util/compat/httpHeaders.ts:69

headerValues

headerValues(): string[]
Get the header values that are contained in this collection.

Returns string[]
- Defined in util/compat/httpHeaders.ts:73

headersArray

headersArray(): HttpHeader[]
Get the headers that are contained in this collection as an array.

Returns HttpHeader[]
- Defined in util/compat/httpHeaders.ts:65

rawHeaders

rawHeaders(): RawHttpHeaders
Get the headers that are contained this collection as an object.

Returns RawHttpHeaders
- Defined in util/compat/httpHeaders.ts:61

remove

remove(headerName): boolean
Remove the header with the provided headerName. Return whether or not the header existed and was removed.
Parameters
- headerName: string
  The name of the header to remove.
Returns boolean
- Defined in util/compat/httpHeaders.ts:57

set

set(headerName, headerValue): void
Set a header in this collection with the provided name and value. The name is case-insensitive.
Parameters
- headerName: string
  The name of the header to set. This value is case-insensitive.
- headerValue: string | number
  The value of the header to set.
Returns void
- Defined in util/compat/httpHeaders.ts:41

toJson

toJson(options?): RawHttpHeaders
Get the JSON object representation of this HTTP header collection. The result is the same as rawHeaders().
Parameters
- Optional options: {
  preserveCase?: boolean;
  }
  - Optional preserveCase?: boolean
Returns RawHttpHeaders
- Defined in util/compat/httpHeaders.ts:82

Generated using TypeDoc