填写这份《一分钟调查》，帮我们（开发组）做得更好！去填写Home
API 参考手册
API > @angular/common > @angular/common/http

HttpHeaders

Http 头的不可变集合，惰性解析。

HttpHeaders class represents the header configuration options for an HTTP request. Instances should be assumed immutable with lazy parsing.

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

构造函数

Constructs a new HTTP header object with the given values.

constructor(headers?: string | { [name: string]: string | string[]; })
      
      constructor(headers?: string | { [name: string]: string | string[]; })
参数
headers string | { [name: string]: string | string[]; }

可选. 默认值是 undefined.

方法

has()

检查是否存在指定名称的头。

Checks for existence of a header by a given name.

has(name: string): boolean
      
      has(name: string): boolean
参数
name string

要检查是否存在的头名称

The header name to check for existence.

返回值

这个头是否存在。

boolean: Whether the header exits.

get()

返回匹配指定名称的第一个头的值。

Returns the first header value that matches a given name.

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

要取的头名称

The header name to retrieve.

返回值

如果头存在则返回一个字符串，否则返回 null

string | null: A string if the header exists, null otherwise

keys()

返回所有的头名称。

Returns the names of the headers.

keys(): string[]
      
      keys(): string[]
参数

没有参数。

返回值

一个头名称列表。

string[]: A list of header names.

getAll()

返回头中具有指定名称的值的列表。

Returns a list of header values for a given header name.

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

准备获取值的头名称

The header name from which to retrieve the values.

返回值

如果头存在则返回一个字符串数组，否则返回 null。

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

append()

Appends a new header value to the existing set of header values.

append(name: string, value: string | string[]): HttpHeaders
      
      append(name: string, value: string | string[]): HttpHeaders
参数
name string

The header name for which to append the values.

value string | string[]
返回值

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

set()

Sets a header value for a given name. If the header name already exists, its value is replaced with the given value.

set(name: string, value: string | string[]): HttpHeaders
      
      set(name: string, value: string | string[]): HttpHeaders
参数
name string

The header name.

value string | string[]

Provides the value to set or overide for a given name.

返回值

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

delete()

Deletes all header values for a given name.

delete(name: string, value?: string | string[]): HttpHeaders
      
      delete(name: string, value?: string | string[]): HttpHeaders
参数
name string

The header name.

value string | string[]

可选. 默认值是 undefined.

The header values to delete for a given name.

返回值

HttpHeaders: A clone of the HTTP header object.