模板语法
服务端渲染
API / @angular/common/http

HttpParams

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

HTTP 请求/响应体，用来表示序列化参数，它们的 MIME 类型都是 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)

参数

options

Type: HttpParamsOptions.

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

方法

has()

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

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

has(param: string): boolean

参数

param

Type: string.

返回值

boolean

get()

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

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

get(param: string): string | null

参数

param

Type: string.

返回值

string | null

getAll()

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

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

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

参数

param

Type: string.

返回值

string[] | null

keys()

Get all the parameter names for this body.

获取此 body 的所有参数名。

keys(): string[]

参数

没有参数。

返回值

string[]

append()

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

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

append(param: string, value: string): HttpParams

参数

param

Type: string.

value

Type: string.

返回值

HttpParams

set()

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

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

set(param: string, value: string): HttpParams

参数

param

Type: string.

value

Type: string.

返回值

HttpParams

delete()

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.

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

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

参数

param

Type: string.

value

Type: string.

可选. 默认值是 undefined.

返回值

HttpParams

toString()

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

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

toString(): string

参数

没有参数。

返回值

string