This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.

Headers

Polyfill for Headers, as specified in the Fetch Spec.

See more...

Deprecated: see https://angular.io/guide/http

      
      class Headers {
  static fromResponseHeaderString(headersString: string): Headers
  constructor(headers?: Headers | {...})
  append(name: string, value: string): void
  delete(name: string): void
  forEach(fn: (values: string[], name: string | undefined, headers: Map<string, string[]>) => void): void
  get(name: string): string | null
  has(name: string): boolean
  keys(): string[]
  set(name: string, value: string | string[]): void
  values(): string[][]
  toJSON(): {...}
  getAll(name: string): string[] | null
  entries()
}
    

Description

The only known difference between this Headers implementation and the spec is the lack of an entries method.

Static methods

Returns a new Headers instance from the given DOMString of Response Headers

static fromResponseHeaderString(headersString: string): Headers
      
      static fromResponseHeaderString(headersString: string): Headers
    

Parameters

headersString

Type: string.

Returns

Headers

Constructor

constructor(headers?: Headers | { [name: string]: any; } | null)
      
      constructor(headers?: Headers | {
    [name: string]: any;
} | null)
    

Parameters

headers

Type: Headers | { [name: string]: any; } | null.

Optional. Default is undefined.

Methods

Appends a header to existing list of header values for a given header name.

append(name: string, value: string): void
      
      append(name: string, value: string): void
    

Parameters

name

Type: string.

value

Type: string.

Returns

void

Deletes all header values for the given name.

delete(name: string): void
      
      delete(name: string): void
    

Parameters

name

Type: string.

Returns

void

forEach(fn: (values: string[], name: string | undefined, headers: Map<string, string[]>) => void): void
      
      forEach(fn: (values: string[], name: string | undefined, headers: Map<string, string[]>) => void): void
    

Parameters

fn

Type: (values: string[], name: string | undefined, headers: Map) => void.

Returns

void

Returns first header that matches given name.

get(name: string): string | null
      
      get(name: string): string | null
    

Parameters

name

Type: string.

Returns

string | null

Checks for existence of header by given name.

has(name: string): boolean
      
      has(name: string): boolean
    

Parameters

name

Type: string.

Returns

boolean

Returns the names of the headers

keys(): string[]
      
      keys(): string[]
    

Parameters

There are no parameters.

Returns

string[]

Sets or overrides header value for given name.

set(name: string, value: string | string[]): void
      
      set(name: string, value: string | string[]): void
    

Parameters

name

Type: string.

value

Type: string | string[].

Returns

void

Returns values of all headers.

values(): string[][]
      
      values(): string[][]
    

Parameters

There are no parameters.

Returns

string[][]

Returns string of all headers.

toJSON(): { [name: string]: any; }
      
      toJSON(): {
    [name: string]: any;
}
    

Parameters

There are no parameters.

Returns

`{

}`

Returns list of header values for a given name.

getAll(name: string): string[] | null
      
      getAll(name: string): string[] | null
    

Parameters

name

Type: string.

Returns

string[] | null

This method is not implemented.

entries()
      
      entries()
    

Parameters

There are no parameters.

Usage notes

Example

import {Headers} from '@angular/http'; var firstHeaders = new Headers(); firstHeaders.append('Content-Type', 'image/jpeg'); console.log(firstHeaders.get('Content-Type')) //'image/jpeg' // Create headers from Plain Old JavaScript Object var secondHeaders = new Headers({ 'X-My-Custom-Header': 'Angular' }); console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular' var thirdHeaders = new Headers(secondHeaders); console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular'
      
      
  1. import {Headers} from '@angular/http';
  2.  
  3. var firstHeaders = new Headers();
  4. firstHeaders.append('Content-Type', 'image/jpeg');
  5. console.log(firstHeaders.get('Content-Type')) //'image/jpeg'
  6.  
  7. // Create headers from Plain Old JavaScript Object
  8. var secondHeaders = new Headers({
  9. 'X-My-Custom-Header': 'Angular'
  10. });
  11. console.log(secondHeaders.get('X-My-Custom-Header')); //'Angular'
  12.  
  13. var thirdHeaders = new Headers(secondHeaders);
  14. console.log(thirdHeaders.get('X-My-Custom-Header')); //'Angular'