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

HttpParamslink

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

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

\n\n

See more...

\n
\n \n \n \n
\n\nclass HttpParams {\n constructor(options: HttpParamsOptions = {} as HttpParamsOptions)\n has(param: string): boolean\n get(param: string): string | null\n getAll(param: string): string[] | null\n keys(): string[]\n append(param: string, value: string | number | boolean): HttpParams\n appendAll(params: { [param: string]: string | number | boolean | readonly (string | number | boolean)[]; }): HttpParams\n set(param: string, value: string | number | boolean): HttpParams\n delete(param: string, value?: string | number | boolean): HttpParams\n toString(): string\n}\n\n\n \n \n\n
\n\n\n \n\n \n \n
\n

Descriptionlink

\n

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

\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\n constructor(options: HttpParamsOptions = {} as HttpParamsOptions)\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n options\n HttpParamsOptions\n

Optional. Default is {} as HttpParamsOptions.

\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

Reports whether the body includes one or more values for a given parameter.

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

The parameter name.

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

boolean: True if the parameter has one or more values,\nfalse if it has no value or is not present.

\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 for a parameter.

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

The parameter name.

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

string | null: The first value of the given parameter,\nor null if the parameter is not present.

\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 all values for a parameter.

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

The parameter name.

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

string[] | null: All values in a string array,\nor null if the parameter not present.

\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 all the parameters for this body.

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

There are no parameters.

\n\n \n
Returns
\n

string[]: The parameter names in a string array.

\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 existing values for a parameter.

\n\n
\n
\n \n\n append(param: string, value: string | number | boolean): HttpParams\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n param\n string\n

The parameter name.

\n\n
\n \n value\n string | number | boolean\n

The new value to add.

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

HttpParams: A new body with the appended 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 appendAll()\n \n link

\n \n
\n
\n

Constructs a new body with appended values for the given parameter name.

\n\n
\n
\n \n\n appendAll(params: { [param: string]: string | number | boolean | readonly (string | number | boolean)[]; }): HttpParams\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n params\n object\n

parameters and values

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

HttpParams: A new body with the new 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 set()\n \n link

\n \n
\n
\n

Replaces the value for a parameter.

\n\n
\n
\n \n\n set(param: string, value: string | number | boolean): HttpParams\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n param\n string\n

The parameter name.

\n\n
\n \n value\n string | number | boolean\n

The new value.

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

HttpParams: A new body with the new 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

Removes a given value or all values from a parameter.

\n\n
\n
\n \n\n delete(param: string, value?: string | number | boolean): HttpParams\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n param\n string\n

The parameter name.

\n\n
\n \n value\n string | number | boolean\n

The value to remove, if provided.

\n

Optional. Default is undefined.

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

HttpParams: A new body with the given value removed, or with all values\nremoved if no value is specified.

\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 toString()\n \n link

\n \n
\n
\n

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

\n\n
\n
\n \n\n toString(): string\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string

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