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


WebResource interface

Описание HTTP-запроса к удаленному серверу.

Свойства

abortSignal

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

body

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

decompressResponse

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

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 для целей совместимости и будет вызываться при вызове.

validateRequestProperties()

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

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

abortSignal

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

abortSignal?: AbortSignalLike

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

body

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

body?: any

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

any

decompressResponse

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

decompressResponse?: boolean

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

boolean

formData

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

formData?: any

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

any

headers

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

headers: HttpHeadersLike

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

keepAlive

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

keepAlive?: boolean

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

boolean

method

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

method: HttpMethods

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

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

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

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

prepare(unknown)

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

function prepare(options: unknown): WebResourceLike

Параметры

options

unknown

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

validateRequestProperties()

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

function validateRequestProperties()