PipelineRequestOptions interface
Параметры для инициализации запроса. Почти эквивалентно Partial<PipelineRequest>, но url обязателен.
Свойства
| abort |
Используется для прерывания запроса позже. |
| agent | ТОЛЬКО NODEJS Параметр только для узла для предоставления пользовательской |
| allow |
Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS |
| body | Содержимое текста HTTP (если таковые есть) |
| disable |
Если подключение не должно использоваться повторно. |
| enable |
ТОЛЬКО БРАУЗЕР Только в браузере можно включить использование API Streams. Если этот параметр задан и используется потоковая передача (см. Значение по умолчанию равно false |
| form |
Имитация записи формы браузера |
| headers | Заголовки HTTP, используемые при выполнении запроса. |
| method | Метод HTTP, используемый при выполнении запроса. |
| multipart |
Текст многопартийного запроса. |
| on |
Обратный вызов, который запускается при выполнении скачивания. |
| on |
Обратный вызов, который запускается при выполнении отправки. |
| proxy |
Конфигурация прокси-сервера. |
| request |
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки. |
| request |
Дополнительные опции можно установить по запросу. Это позволяет переопределить существующие или предоставить свойства запроса, которые не объявлены. Для ознакомления с возможными допустимыми свойствами см.
ВНИМАНИЕ: Указанные здесь параметры будут переопределять любые свойства с одинаковыми именами при отправке запроса HttpClient. |
| stream |
Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток. |
| timeout | Число миллисекундах запроса может приниматься перед автоматическим завершением.
Если запрос завершается, создается |
| tls |
Параметры настройки проверки подлинности TLS |
| tracing |
Параметры, используемые для создания диапазона при включении трассировки. |
| url | URL-адрес для выполнения запроса. |
| with |
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. По умолчанию используется значение false. |
Сведения о свойстве
abortSignal
Используется для прерывания запроса позже.
abortSignal?: AbortSignalLikeЗначение свойства
agent
ТОЛЬКО NODEJS
Параметр только для узла для предоставления пользовательской http.Agent/https.Agent.
ПРИМЕЧАНИЕ. Обычно это должен быть один экземпляр, совместно используемый несколькими запросами, чтобы базовое подключение к службе можно было повторно использовать.
Ничего не делает при выполнении в браузере.
agent?: AgentЗначение свойства
allowInsecureConnection
Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS
allowInsecureConnection?: booleanЗначение свойства
boolean
body
disableKeepAlive
Если подключение не должно использоваться повторно.
disableKeepAlive?: booleanЗначение свойства
boolean
enableBrowserStreams
ТОЛЬКО БРАУЗЕР
Только в браузере можно включить использование API Streams. Если этот параметр задан и используется потоковая передача (см. streamResponseStatusCodes), ответ будет иметь свойство browserStream вместо blobBody, которые будут неопределенными.
Значение по умолчанию равно false
enableBrowserStreams?: booleanЗначение свойства
boolean
formData
headers
Заголовки HTTP, используемые при выполнении запроса.
headers?: HttpHeadersЗначение свойства
method
multipartBody
Текст многопартийного запроса.
multipartBody?: MultipartRequestBodyЗначение свойства
onDownloadProgress
Обратный вызов, который запускается при выполнении скачивания.
onDownloadProgress?: (progress: TransferProgressEvent) => voidЗначение свойства
(progress: TransferProgressEvent) => void
onUploadProgress
Обратный вызов, который запускается при выполнении отправки.
onUploadProgress?: (progress: TransferProgressEvent) => voidЗначение свойства
(progress: TransferProgressEvent) => void
proxySettings
requestId
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.
requestId?: stringЗначение свойства
string
requestOverrides
Дополнительные опции можно установить по запросу. Это позволяет переопределить существующие или предоставить свойства запроса, которые не объявлены.
Для ознакомления с возможными допустимыми свойствами см.
- Варианты https.request в NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
- Browser RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
ВНИМАНИЕ: Указанные здесь параметры будут переопределять любые свойства с одинаковыми именами при отправке запроса HttpClient.
requestOverrides?: Record<string, unknown>Значение свойства
Record<string, unknown>
streamResponseStatusCodes
Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток.
streamResponseStatusCodes?: Set<number>Значение свойства
Set<number>
timeout
Число миллисекундах запроса может приниматься перед автоматическим завершением.
Если запрос завершается, создается AbortError.
Значение по умолчанию — 0, которое отключает время ожидания.
timeout?: numberЗначение свойства
number
tlsSettings
Параметры настройки проверки подлинности TLS
tlsSettings?: TlsSettingsЗначение свойства
tracingOptions
Параметры, используемые для создания диапазона при включении трассировки.
tracingOptions?: OperationTracingOptionsЗначение свойства
url
URL-адрес для выполнения запроса.
url: stringЗначение свойства
string
withCredentials
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. По умолчанию используется значение false.
withCredentials?: booleanЗначение свойства
boolean