PipelineRequestOptions interface
Параметры для инициализации запроса. Почти эквивалентно Partial<PipelineRequest>, но url обязателен.
Свойства
| abort |
Используется для прерывания запроса позже. |
| body | Содержимое текста HTTP (если таковые есть) |
| form |
Имитация записи формы браузера |
| headers | Заголовки HTTP, используемые при выполнении запроса. |
| keep |
Если подключение должно использоваться повторно. По умолчанию используется значение true. |
| method | Метод HTTP, используемый при выполнении запроса. |
| on |
Обратный вызов, который запускается при выполнении скачивания. |
| on |
Обратный вызов, который запускается при выполнении отправки. |
| proxy |
Настройка прокси. |
| request |
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки. |
| span |
Параметры, используемые для создания диапазона при включении трассировки. |
| stream |
Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток. |
| timeout | Число миллисекундах запроса может приниматься перед автоматическим завершением.
Если запрос завершается, создается |
| url | URL-адрес для выполнения запроса. |
| with |
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. По умолчанию false. |
Сведения о свойстве
abortSignal
Используется для прерывания запроса позже.
abortSignal?: AbortSignalLike
Значение свойства
body
formData
headers
Заголовки HTTP, используемые при выполнении запроса.
headers?: HttpHeaders
Значение свойства
keepAlive
Если подключение должно использоваться повторно. По умолчанию используется значение true.
keepAlive?: boolean
Значение свойства
boolean
method
onDownloadProgress
Обратный вызов, который запускается при выполнении скачивания.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
onUploadProgress
Обратный вызов, который запускается при выполнении отправки.
onUploadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
proxySettings
requestId
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.
requestId?: string
Значение свойства
string
spanOptions
Параметры, используемые для создания диапазона при включении трассировки.
spanOptions?: SpanOptions
Значение свойства
streamResponseStatusCodes
Список кодов состояния ответа, соответствующий текст PipelineResponse, должен рассматриваться как поток.
streamResponseStatusCodes?: Set<number>
Значение свойства
Set<number>
timeout
Число миллисекундах запроса может приниматься перед автоматическим завершением.
Если запрос завершается, создается AbortError.
Значение по умолчанию — 0, которое отключает время ожидания.
timeout?: number
Значение свойства
number
url
URL-адрес для выполнения запроса.
url: string
Значение свойства
string
withCredentials
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. По умолчанию false.
withCredentials?: boolean
Значение свойства
boolean