HttpResourceRequest — Angular

Структура запроса httpResource, который будет отправлен на серверную часть.

API

interface HttpResourceRequest {
  url: string;
  method?: string | undefined;
  body?: unknown;
  params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined;
  headers?: HttpHeaders | Record<string, string | readonly string[]> | undefined;
  context?: HttpContext | undefined;
  reportProgress?: boolean | undefined;
  withCredentials?: boolean | undefined;
  keepalive?: boolean | undefined;
  cache?: RequestCache | (string & {}) | undefined;
  credentials?: (string & {}) | RequestCredentials | undefined;
  priority?: (string & {}) | RequestPriority | undefined;
  mode?: (string & {}) | RequestMode | undefined;
  redirect?: (string & {}) | RequestRedirect | undefined;
  referrer?: string | undefined;
  referrerPolicy?: (string & {}) | ReferrerPolicy | undefined;
  integrity?: string | undefined;
  transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined;
  timeout?: number | undefined;
}

url

string

URL запроса.

Этот URL не должен содержать параметры запроса. Вместо этого укажите параметры запроса в поле params.

method

string | undefined

Метод HTTP-запроса. Если он не указан, используется GET.

body

unknown

Тело запроса, если оно есть.

Если пользователь не указал заголовок Content-Type, Angular попытается задать его на основе типа body.

params

Словарь параметров запроса, которые будут добавлены к URL запроса.

headers

HttpHeaders | Record<string, string | readonly string[]> | undefined

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

context

HttpContext | undefined

Контекст запроса, хранящийся в словаре пар «ключ-значение».

reportProgress

boolean | undefined

Если true, для запроса будут включены события отслеживания хода выполнения, которые будут передаваться через сигнал HttpResource.progress.

withCredentials

boolean | undefined

Указывает, следует ли установить флаг withCredentials для исходящего запроса.

Этот флаг заставляет браузер отправлять вместе с запросом файлы cookie и другие данные аутентификации.

keepalive

boolean | undefined

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

cache

RequestCache | (string & {}) | undefined

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

credentials

(string & {}) | RequestCredentials | undefined

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

priority

(string & {}) | RequestPriority | undefined

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

mode

(string & {}) | RequestMode | undefined

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

redirect

(string & {}) | RequestRedirect | undefined

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

referrer

string | undefined

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

referrerPolicy

(string & {}) | ReferrerPolicy | undefined

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

integrity

string | undefined

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

transferCache

boolean | { includeHeaders?: string[] | undefined; } | undefined

Настраивает кэш передачи при серверном рендеринге для этого запроса.

Дополнительные сведения см. в документации по кэшу передачи.

timeout

number | undefined

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