WebResource interface

Пакет:

@azure/storage-blob

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

Свойства

abortSignal	Сигнал контроллера прерывания. Можно использовать для прерывания отправки сетевого запроса и ожидания ответа.
agent	ТОЛЬКО NODEJS Параметр только для узла для предоставления пользовательской http.Agent/https.Agent. ПРИМЕЧАНИЕ. Обычно это должен быть один экземпляр, совместно используемый несколькими запросами, чтобы базовое подключение к службе можно было повторно использовать. Ничего не делает при выполнении в браузере.
body	Содержимое текста HTTP запроса.
decompressResponse	Следует ли декомпрессировать ответ в соответствии с заголовком Accept-Encoding (только узел-извлечение)
formData	Данные формы, используемые для создания текста запроса.
headers	Заголовки HTTP, используемые при выполнении запроса.
keepAlive	Если подключение должно использоваться повторно.
method	Метод HTTP, используемый при выполнении запроса.
onDownloadProgress	Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
proxySettings	Конфигурация прокси-сервера.
query	Строка запроса, представленная как объект.
requestId	Уникальный идентификатор запроса. Используется для ведения журнала и трассировки.
streamResponseBody	Следует ли рассматривать текст httpOperationResponse как поток.
streamResponseStatusCodes	Список кодов состояния ответа, соответствующий текст HttpOperationResponse, должен рассматриваться как поток.
timeout	Число миллисекундах запроса может приниматься перед автоматическим завершением. Если запрос завершается, создается AbortError.
url	URL-адрес, к которым обращается запрос.
withCredentials	Если учетные данные (файлы cookie) должны быть отправлены во время XHR.

Методы

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

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

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

agent

ТОЛЬКО NODEJS

Параметр только для узла для предоставления пользовательской http.Agent/https.Agent. ПРИМЕЧАНИЕ. Обычно это должен быть один экземпляр, совместно используемый несколькими запросами, чтобы базовое подключение к службе можно было повторно использовать. Ничего не делает при выполнении в браузере.

agent?: Agent

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

Agent

body

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

body?: any

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

any

decompressResponse

Следует ли декомпрессировать ответ в соответствии с заголовком Accept-Encoding (только узел-извлечение)

decompressResponse?: boolean

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

boolean

formData

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

formData?: any

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

any

headers

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

headers: HttpHeadersLike

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

HttpHeaders

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

proxySettings

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

proxySettings?: ProxySettings

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

ProxySettings

query

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

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

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

{[key: string]: any}

requestId

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

requestId: string

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

string

streamResponseBody

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

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

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

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

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

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

Set<number>

timeout

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

timeout: number

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

number

url

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

url: string

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

string

withCredentials

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

withCredentials: boolean

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

boolean

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

clone()

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

function clone(): WebResourceLike

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

WebResource

prepare(unknown)

Это no-op для compat-целей и будет вызываться при вызове.

function prepare(options: unknown): WebResourceLike

Параметры

options

unknown

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

WebResource

validateRequestProperties()

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

function validateRequestProperties()