WebResourceLike interface

Пакет:

@azure/ms-rest-js

Абстракция по вызову REST.

Свойства

abortSignal	Используется для прерывания запроса позже.
agentSettings	Конфигурация агента HTTP(S).
body	Содержимое текста HTTP запроса.
formData
headers	Заголовки HTTP, используемые при выполнении запроса.
keepAlive	Если подключение должно использоваться повторно.
method	Метод HTTP, используемый при выполнении запроса.
onDownloadProgress	Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
operationResponseGetter	Функция, возвращающая правильное сочетание OperationResponse для заданной комбинации OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния.
operationSpec	Используется для анализа ответа.
proxySettings	Конфигурация прокси-сервера.
query	Строка запроса, представленная как объект.
redirectLimit	Ограничить количество перенаправлений, за которыми следует выполнить этот запрос. Если задано значение 0, перенаправления не будут выполняться. Если слева не определено поведение перенаправления по умолчанию базового node_fetch будет применено.
shouldDeserialize	Следует ли десериализировать httpOperationResponse. Если это не определено, необходимо десериализировать httpOperationResponse.
streamResponseBody	Следует ли рассматривать текст httpOperationResponse как поток.
timeout	Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError.
url	URL-адрес, к которым обращается запрос.
withCredentials	Если учетные данные (файлы cookie) должны быть отправлены во время XHR.

Методы

clone()	Клонируйте этот объект запроса.
prepare(RequestPrepareOptions)	Задает параметры запроса.
validateRequestProperties()	Проверяет, определены ли обязательные свойства, такие как метод, URL-адрес, заголовки["Content-Type"], заголовки["accept-language"]. Это приведет к ошибке, если одно из указанных выше свойств не определено.

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

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

agentSettings

Конфигурация агента HTTP(S).

agentSettings?: AgentSettings

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

AgentSettings

body

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

body?: any

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

any

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}

redirectLimit

Ограничить количество перенаправлений, за которыми следует выполнить этот запрос. Если задано значение 0, перенаправления не будут выполняться. Если слева не определено поведение перенаправления по умолчанию базового node_fetch будет применено.

redirectLimit?: number

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

number

shouldDeserialize

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

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

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

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Следует ли рассматривать текст httpOperationResponse как поток.

streamResponseBody?: boolean

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

boolean

timeout

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

timeout: number

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

number

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()

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

function validateRequestProperties()