API 参考手册
API > @angular/common > @angular/common/http

HttpParams

HTTP 请求/响应体，用来表示序列化参数，它们的 MIME 类型都是 application/x-www-form-urlencoded。

An HTTP request/response body that represents serialized parameters, per the MIME type application/x-www-form-urlencoded.

查看"说明"...

      
      class HttpParams {
  constructor(options: HttpParamsOptions = {} as HttpParamsOptions)
  has(param: string): boolean
  get(param: string): string | null
  getAll(param: string): string[] | null
  keys(): string[]
  append(param: string, value: string): HttpParams
  set(param: string, value: string): HttpParams
  delete(param: string, value?: string): HttpParams
  toString(): string
}

说明

这个类是不可变的 - 每个修改类的操作都会返回一个新实例。

This class is immutable - all mutation operations return a new instance.

构造函数

constructor(options: HttpParamsOptions = {} as HttpParamsOptions)
      
      constructor(options: HttpParamsOptions = {} as HttpParamsOptions)
参数
options HttpParamsOptions

可选. 默认值是 {} as HttpParamsOptions.

方法

has()

检查 body 中是否存在一个或多个具有指定参数名的值。

Check whether the body has one or more values for the given parameter name.

has(param: string): boolean
      
      has(param: string): boolean
参数
param string
返回值

boolean

get()

获取给定参数名对应的第一个值，如果没有则返回 null。

Get the first value for the given parameter name, or null if it's not present.

get(param: string): string | null
      
      get(param: string): string | null
参数
param string
返回值

string | null

getAll()

获取给定参数名对应的所有值，如果没有则返回 null。

Get all values for the given parameter name, or null if it's not present.

getAll(param: string): string[] | null
      
      getAll(param: string): string[] | null
参数
param string
返回值

string[] | null

keys()

获取此 body 的所有参数名。

Get all the parameter names for this body.

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

没有参数。

返回值

string[]

append()

构造一个新的 body，添加一个具有给定参数名的值。

Construct a new body with an appended value for the given parameter name.

append(param: string, value: string): HttpParams
      
      append(param: string, value: string): HttpParams
参数
param string
value string
返回值

HttpParams

set()

构造一个新的 body，具有一个给定参数名的新值。

Construct a new body with a new value for the given parameter name.

set(param: string, value: string): HttpParams
      
      set(param: string, value: string): HttpParams
参数
param string
value string
返回值

HttpParams

delete()

构造一个新的 body，如果指定了 value，则移除具有指定 value 和指定 param 的条目；如果没有指定 value，则移除指定 param 对应的所有值。

Construct a new body with either the given value for the given parameter removed, if a value is given, or all values for the given parameter removed if not.

delete(param: string, value?: string): HttpParams
      
      delete(param: string, value?: string): HttpParams
参数
param string
value string

可选. 默认值是 undefined.

返回值

HttpParams

toString()

把该 body 序列化为一个编码过的字符串，其中的 key-value 对（用 = 分隔）会以 & 分隔。

Serialize the body to an encoded string, where key-value pairs (separated by =) are separated by &s.

toString(): string
      
      toString(): string
参数

没有参数。

返回值

string