Share via

WebResourceLike interface

  • Ссылка
Пакет:
@azure/core-http

Описание HTTP-запроса, который должен быть выполнен к удаленному серверу.

Свойства

abortSignal

Сигнал контроллера прерывания. Может использоваться для прерывания отправки сетевого запроса и ожидания ответа.
body

Содержимое текста HTTP запроса.
decompressResponse

Указывает, следует ли распаковывать ответ в соответствии с заголовком Accept-Encoding (только node-fetch)
formData

Данные формы, используемые для построения текста запроса.
headers

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

Если подключение следует использовать повторно.
method

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

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

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

Функция, которая возвращает правильный operationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если этот параметр не определен, будет использоваться простой поиск кода состояния.
operationSpec

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

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

Строка запроса, представленная в виде объекта .
requestId

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

Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.
streamResponseBody

Указывает, следует ли рассматривать тело HttpOperationResponse как поток.
streamResponseStatusCodes

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

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

Трассировка: контекст, используемый при создании диапазонов.
url

URL-адрес, к которым обращается запрос.
withCredentials

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

Методы

clone()

Клонируйте этот объект запроса.
prepare(RequestPrepareOptions)

Задает параметры запроса.
validateRequestProperties()

Проверяет, определены ли необходимые свойства, такие как method, url, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, будет выдаваться ошибка.

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

abortSignal

Сигнал контроллера прерывания. Может использоваться для прерывания отправки сетевого запроса и ожидания ответа.

abortSignal?: AbortSignalLike

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

AbortSignalLike

body

Содержимое текста HTTP запроса.

body?: any

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

any

decompressResponse

Указывает, следует ли распаковывать ответ в соответствии с заголовком Accept-Encoding (только node-fetch)

decompressResponse?: boolean

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

boolean

formData

Данные формы, используемые для построения текста запроса.

formData?: any

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

any

headers

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

headers: HttpHeadersLike

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

HttpHeadersLike

keepAlive

Если подключение следует использовать повторно.

keepAlive?: boolean

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

boolean

method

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

method: HttpMethods

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

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

operationResponseGetter

Функция, которая возвращает правильный operationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если этот параметр не определен, будет использоваться простой поиск кода состояния.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

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

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

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

operationSpec?: OperationSpec

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

OperationSpec

proxySettings

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

proxySettings?: ProxySettings

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

ProxySettings

query

Строка запроса, представленная в виде объекта .

query?: {[key: string]: any}

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

{[key: string]: any}

requestId

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

requestId: string

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

string

shouldDeserialize

Следует ли десериализовать httpOperationResponse. Если этот параметр не определен, следует десериализовать httpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

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

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Предупреждение

Теперь этот API является нерекомендуемым.

Use streamResponseStatusCodes property instead.

Указывает, следует ли рассматривать тело HttpOperationResponse как поток.

streamResponseBody?: boolean

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

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

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

Set<number>

timeout

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

timeout: number

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

number

tracingContext

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

tracingContext?: Context

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

@azure/core-tracing.Context

url

URL-адрес, к которым обращается запрос.

url: string

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

string

withCredentials

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

withCredentials: boolean

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

boolean

Сведения о методе

clone()

Клонируйте этот объект запроса.

function clone(): WebResourceLike

Возвращаемое значение

WebResourceLike

prepare(RequestPrepareOptions)

Задает параметры запроса.

function prepare(options: RequestPrepareOptions): WebResourceLike

Параметры

options
RequestPrepareOptions

Возвращаемое значение

WebResourceLike

validateRequestProperties()

Проверяет, определены ли необходимые свойства, такие как method, url, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, будет выдаваться ошибка.

function validateRequestProperties()