HttpParams — Angular | Spec-Zone.ru

Тело HTTP-запроса/ответа, представляющее сериализованные параметры в соответствии с MIME-типом application/x-www-form-urlencoded.

API

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

constructor

HttpParams

@paramoptionsHttpParamsOptions

@returnsHttpParams

has

boolean

Сообщает, содержит ли тело одно или несколько значений для заданного параметра.

@paramparamstring

Имя параметра.

@returnsboolean

True, если у параметра есть одно или несколько значений; false, если у него нет значения или он отсутствует.

get

string | null

Получает первое значение параметра.

@paramparamstring

Имя параметра.

@returnsstring | null

Первое значение заданного параметра или null, если параметр отсутствует.

getAll

string[] | null

Получает все значения параметра.

@paramparamstring

Имя параметра.

@returnsstring[] | null

Все значения в виде строкового массива или null, если параметр отсутствует.

keys

string[]

Получает все параметры этого тела.

@returnsstring[]

Имена параметров в виде строкового массива.

append

HttpParams

Добавляет новое значение к существующим значениям параметра.

@paramparamstring

Имя параметра.

@paramvaluestring | number | boolean

Новое значение для добавления.

@returnsHttpParams

appendAll

HttpParams

Создаёт новое тело с добавленными значениями для заданного имени параметра.

@paramparams{ [param: string]: string | number | boolean | readonly (string | number | boolean)[]; }

Параметры и значения

@returnsHttpParams

set

HttpParams

Заменяет значение параметра.

@paramparamstring

Имя параметра.

@paramvaluestring | number | boolean

Новое значение.

@returnsHttpParams

delete

HttpParams

Удаляет заданное значение или все значения параметра.

@paramparamstring

Имя параметра.

@paramvaluestring | number | boolean | undefined

Значение для удаления, если оно указано.

@returnsHttpParams

toString

string

Сериализует тело в закодированную строку, в которой пары «ключ-значение» (разделённые =) отделяются друг от друга с помощью &.

@returnsstring

Описание

Этот класс неизменяемый; все операции изменения возвращают новый экземпляр.