{ "id": "api/common/http/HttpHeaders", "title": "HttpHeaders", "contents": "\n\n
\n
\n
\n \n API > @angular/common > @angular/common/http\n
\n \n
\n \n
\n

HttpHeaderslink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

Represents the header configuration options for an HTTP request.\nInstances are immutable. Modifying methods return a cloned\ninstance with the change. The original object is never changed.

\n\n \n
\n \n \n \n
\n\nclass HttpHeaders {\n constructor(headers?: string | { [name: string]: string | string[]; })\n has(name: string): boolean\n get(name: string): string | null\n keys(): string[]\n getAll(name: string): string[] | null\n append(name: string, value: string | string[]): HttpHeaders\n set(name: string, value: string | string[]): HttpHeaders\n delete(name: string, value?: string | string[]): HttpHeaders\n}\n\n\n \n \n\n
\n\n\n \n\n \n \n \n\n\n\n\n\n\n

Constructorlink

\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n

Constructs a new HTTP header object with the given values.

\n\n
\n
\n \n\n constructor(headers?: string | { [name: string]: string | string[]; })\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n headers\n string | { [name: string]: string | string[]; }\n

Optional. Default is undefined.

\n \n
\n\n \n\n\n \n\n \n
\n
\n\n\n\n\n\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n has()\n \n link

\n \n
\n
\n

Checks for existence of a given header.

\n\n
\n
\n \n\n has(name: string): boolean\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name to check for existence.

\n\n
\n\n \n
Returns
\n

boolean: True if the header exists, false otherwise.

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n get()\n \n link

\n \n
\n
\n

Retrieves the first value of a given header.

\n\n
\n
\n \n\n get(name: string): string | null\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name.

\n\n
\n\n \n
Returns
\n

string | null: The value string if the header exists, null otherwise

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n keys()\n \n link

\n \n
\n
\n

Retrieves the names of the headers.

\n\n
\n
\n \n\n keys(): string[]\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string[]: A list of header names.

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getAll()\n \n link

\n \n
\n
\n

Retrieves a list of values for a given header.

\n\n
\n
\n \n\n getAll(name: string): string[] | null\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name from which to retrieve values.

\n\n
\n\n \n
Returns
\n

string[] | null: A string of values if the header exists, null otherwise.

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n append()\n \n link

\n \n
\n
\n

Appends a new value to the existing set of values for a header\nand returns them in a clone of the original instance.

\n\n
\n
\n \n\n append(name: string, value: string | string[]): HttpHeaders\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name for which to append the values.

\n\n
\n \n value\n string | string[]\n

The value to append.

\n\n
\n\n \n
Returns
\n

HttpHeaders: A clone of the HTTP headers object with the value appended to the given header.

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n set()\n \n link

\n \n
\n
\n

Sets or modifies a value for a given header in a clone of the original instance.\nIf the header already exists, its value is replaced with the given value\nin the returned object.

\n\n
\n
\n \n\n set(name: string, value: string | string[]): HttpHeaders\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name.

\n\n
\n \n value\n string | string[]\n

The value or values to set or overide for the given header.

\n\n
\n\n \n
Returns
\n

HttpHeaders: A clone of the HTTP headers object with the newly set header value.

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n delete()\n \n link

\n \n
\n
\n

Deletes values for a given header in a clone of the original instance.

\n\n
\n
\n \n\n delete(name: string, value?: string | string[]): HttpHeaders\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n name\n string\n

The header name.

\n\n
\n \n value\n string | string[]\n

The value or values to delete for the given header.

\n

Optional. Default is undefined.

\n\n
\n\n \n
Returns
\n

HttpHeaders: A clone of the HTTP headers object with the given value deleted.

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }