HttpRequest — Angular

Исходящий HTTP-запрос с необязательным типизированным телом.

API

class HttpRequest<T> implements HttpRequestOptions {
  constructor(method: "GET" | "HEAD", url: string, init?: HttpRequestOptions | undefined): HttpRequest;
  constructor(method: "DELETE" | "JSONP" | "OPTIONS", url: string, init?: HttpRequestOptions | undefined): HttpRequest;
  constructor(method: "POST", url: string, body: T | null, init?: HttpRequestOptions | undefined): HttpRequest;
  constructor(method: "PUT" | "PATCH", url: string, body: T | null, init?: HttpRequestOptions | undefined): HttpRequest;
  constructor(method: string, url: string, body: T | null, init?: HttpRequestOptions | undefined): HttpRequest;
  readonly body: T | null;
  readonly headers: HttpHeaders;
  readonly context: HttpContext;
  readonly reportProgress: boolean;
  readonly reportUploadProgress: boolean;
  readonly reportDownloadProgress: boolean;
  readonly withCredentials: boolean;
  readonly credentials: RequestCredentials;
  readonly keepalive: boolean;
  readonly cache: RequestCache;
  readonly priority: RequestPriority;
  readonly mode: RequestMode;
  readonly redirect: RequestRedirect;
  readonly referrer: string;
  readonly integrity: string;
  readonly referrerPolicy: ReferrerPolicy;
  readonly responseType: HttpResponseType;
  readonly method: string;
  readonly params: HttpParams;
  readonly urlWithParams: string;
  readonly transferCache?: HttpTransferCacheRequestOptions | undefined;
  readonly timeout?: number | undefined;
  serializeBody(): string | ArrayBuffer | Blob | FormData | URLSearchParams | null;
  detectContentTypeHeader(): string | null;
  clone(): HttpRequest<T>;
  clone(update: HttpRequestOptions & { body?: T | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }): HttpRequest<T>;
  clone<V>(update: HttpRequestOptions & { body?: V | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }): HttpRequest<V>;
}

constructor

5 перегрузок

@parammethod"GET" | "HEAD"

@paramurlstring

@paraminitHttpRequestOptions | undefined

@returnsHttpRequest

@parammethod"DELETE" | "JSONP" | "OPTIONS"

@paramurlstring

@paraminitHttpRequestOptions | undefined

@returnsHttpRequest

@parammethod"POST"

@paramurlstring

@parambodyT | null

@paraminitHttpRequestOptions | undefined

@returnsHttpRequest

@parammethod"PUT" | "PATCH"

@paramurlstring

@parambodyT | null

@paraminitHttpRequestOptions | undefined

@returnsHttpRequest

@parammethodstring

@paramurlstring

@parambodyT | null

@paraminitHttpRequestOptions | undefined

@returnsHttpRequest

body

T | null

Тело запроса или null, если оно не задано.

Для тел не гарантируется неизменяемость, поскольку они могут содержать ссылку на любой пользовательский тип данных. Однако перехватчики должны обеспечивать идемпотентность, рассматривая их как неизменяемые.

headers

HttpHeaders

Исходящие заголовки этого запроса.

context

HttpContext

Общий изменяемый контекст, который могут использовать перехватчики

reportProgress

boolean

@deprecated

Вместо этого используйте reportUploadProgress и reportDownloadProgress

Следует ли выполнять этот запрос таким образом, чтобы предоставлять события о ходе выполнения.

Обработка событий о ходе выполнения требует значительных ресурсов (при каждом событии запускается обнаружение изменений), поэтому запрашивать их следует только в том случае, если потребитель собирается их отслеживать.

Примечание. Реализация HttpBackend по умолчанию, основанная на fetch, не поддерживает отслеживание хода загрузки. Если вам нужна эта возможность, задайте HttpXhrBackend с помощью withXhr().

reportUploadProgress

boolean

Если задано значение true, запрос, отправленный через FetchBackend, вызовет ошибку.

reportDownloadProgress

boolean

withCredentials

boolean

Следует ли отправлять этот запрос с учетными данными (файлами cookie).

credentials

RequestCredentials

Режим учетных данных запроса, определяющий обработку файлов cookie и HTTP-аутентификации. Он может влиять на то, будут ли файлы cookie отправлены вместе с запросом и как будет выполняться аутентификация.

keepalive

boolean

При использовании реализации на основе fetch и значении true браузер не прервет соответствующий запрос, если страница, инициировавшая его, будет закрыта до завершения запроса.

cache

RequestCache

Управляет взаимодействием запроса с HTTP-кэшем браузера. Это определяет, будет ли ответ получен из кэша, как он будет сохранен и будет ли кэш полностью обойден.

priority

RequestPriority

Указывает относительный приоритет запроса. Браузер может использовать это значение, чтобы определить порядок отправки запросов и загрузки ресурсов.

mode

RequestMode

Режим запроса, определяющий его взаимодействие с моделью безопасности браузера. Он может влиять, например, на CORS (междоменный обмен ресурсами) и политики одного источника.

redirect

RequestRedirect

Режим перенаправления запроса, определяющий обработку перенаправлений. Он может влиять на то, будет ли запрос автоматически следовать перенаправлениям или завершится ошибкой при перенаправлении.

referrer

string

Источник запроса, который можно использовать для указания происхождения запроса. Это полезно для обеспечения безопасности и аналитики. Значением должен быть URL того же источника, "about:client" или пустая строка, задающая источник запроса.

integrity

string

Метаданные целостности запроса, которые можно использовать, чтобы убедиться, что запрос выполняется с ожидаемым содержимым. Криптографический хеш ресурса, загружаемого запросом

referrerPolicy

ReferrerPolicy

Политика источника запроса, позволяющая указать, какую информацию об источнике следует включать в запрос. Она может влиять на объем передаваемой информации об источнике и использоваться для повышения конфиденциальности и безопасности.

responseType

HttpResponseType

Ожидаемый тип ответа сервера.

Используется для соответствующего разбора ответа перед его возвратом вызывающей стороне.

method

string

Метод исходящего HTTP-запроса.

params

HttpParams

Исходящие параметры URL.

Чтобы передать строковое представление HTTP-параметров в формате строки запроса URL, можно использовать fromString HttpParamsOptions. Например:

new HttpParams({fromString: 'angular=awesome'})

urlWithParams

string

Исходящий URL со всеми заданными параметрами URL.

transferCache

HttpTransferCacheRequestOptions | undefined

Параметр HttpTransferCache для запроса

timeout

number | undefined

Тайм-аут HTTP-запроса к серверной части в миллисекундах.

serializeBody

Преобразует тело произвольного формата в сериализованный формат, пригодный для передачи на сервер.

detectContentTypeHeader

string | null

Проверяет тело и пытается определить подходящий для него тип MIME.

Если определить тип не удастся, этот метод вернет null.

@returnsstring | null

clone

3 перегрузки

@returnsHttpRequest<T>

@paramupdate

HttpRequestOptions & { body?: T | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }

@returnsHttpRequest<T>

@paramupdate

HttpRequestOptions & { body?: V | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }

@returnsHttpRequest<V>

Описание

Исходящий HTTP-запрос с необязательным типизированным телом.

HttpRequest представляет исходящий запрос, включая URL, метод, заголовки, тело и другие параметры конфигурации запроса. Экземпляры следует считать неизменяемыми. Чтобы изменить HttpRequest, следует использовать метод clone.