Поделиться через


PipelineRequestOptions interface

Параметры для инициализации запроса. Почти эквивалентно Partial, но URL-адрес является обязательным.

Свойства

abortSignal

Используется для прерывания запроса позже.

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP, а не по протоколу HTTPS.

body

Содержимое текста HTTP (при наличии)

disableKeepAlive

Значение , если подключение не должно использоваться повторно.

enableBrowserStreams

ТОЛЬКО БРАУЗЕР

Параметр только для браузера, позволяющий использовать API Потоков. Если этот параметр задан и используется потоковая передача (см. streamResponseStatusCodes), ответ будет иметь свойство browserStream , а не blobBody свойство , которое будет неопределенным.

Значение по умолчанию — false.

formData

Имитация записи формы браузера

headers

Заголовки HTTP, используемые при выполнении запроса.

method

Метод HTTP, используемый при выполнении запроса.

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onUploadProgress

Обратный вызов, который срабатывает при выполнении отправки.

proxySettings

Конфигурация прокси-сервера.

requestId

Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.

streamResponseStatusCodes

Список кодов состояния ответа, соответствующий текст PipelineResponse которого следует рассматривать как поток.

timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения. Если запрос завершается, AbortError возникает исключение . По умолчанию — 0, что отключает время ожидания.

tracingOptions

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

url

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

withCredentials

Если учетные данные (файлы cookie) должны быть отправлены во время XHR. Значение по умолчанию — false.

Сведения о свойстве

abortSignal

Используется для прерывания запроса позже.

abortSignal?: AbortSignalLike

Значение свойства

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP, а не по протоколу HTTPS.

allowInsecureConnection?: boolean

Значение свойства

boolean

body

Содержимое текста HTTP (при наличии)

body?: RequestBodyType

Значение свойства

disableKeepAlive

Значение , если подключение не должно использоваться повторно.

disableKeepAlive?: boolean

Значение свойства

boolean

enableBrowserStreams

ТОЛЬКО БРАУЗЕР

Параметр только для браузера, позволяющий использовать API Потоков. Если этот параметр задан и используется потоковая передача (см. streamResponseStatusCodes), ответ будет иметь свойство browserStream , а не blobBody свойство , которое будет неопределенным.

Значение по умолчанию — false.

enableBrowserStreams?: boolean

Значение свойства

boolean

formData

Имитация записи формы браузера

formData?: FormDataMap

Значение свойства

headers

Заголовки HTTP, используемые при выполнении запроса.

headers?: HttpHeaders

Значение свойства

method

Метод HTTP, используемый при выполнении запроса.

method?: HttpMethods

Значение свойства

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

onUploadProgress

Обратный вызов, который срабатывает при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

proxySettings

Конфигурация прокси-сервера.

proxySettings?: ProxySettings

Значение свойства

requestId

Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.

requestId?: string

Значение свойства

string

streamResponseStatusCodes

Список кодов состояния ответа, соответствующий текст PipelineResponse которого следует рассматривать как поток.

streamResponseStatusCodes?: Set<number>

Значение свойства

Set<number>

timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения. Если запрос завершается, AbortError возникает исключение . По умолчанию — 0, что отключает время ожидания.

timeout?: number

Значение свойства

number

tracingOptions

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

tracingOptions?: OperationTracingOptions

Значение свойства

url

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

url: string

Значение свойства

string

withCredentials

Если учетные данные (файлы cookie) должны быть отправлены во время XHR. Значение по умолчанию — false.

withCredentials?: boolean

Значение свойства

boolean