WebResource interface
Описание HTTP-запроса к удаленному серверу.
Свойства
abort |
Сигнал контроллера прерывания. Можно использовать для прерывания отправки сетевого запроса и ожидания ответа. |
body | Содержимое текста HTTP запроса. |
decompress |
Указывает, следует ли распаковывать ответ в соответствии с заголовком Accept-Encoding (только node-fetch) |
form |
Данные формы, используемые для создания текста запроса. |
headers | Заголовки HTTP, используемые при выполнении запроса. |
keep |
Значение , если подключение следует использовать повторно. |
method | Метод HTTP, используемый при выполнении запроса. |
on |
Обратный вызов, который срабатывает при скачивании. |
on |
Обратный вызов, который запускается при выполнении отправки. |
proxy |
Конфигурация прокси-сервера. |
query | Строка запроса, представленная в виде объекта . |
request |
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки. |
stream |
Указывает, следует ли обрабатывать тело HttpOperationResponse как поток. |
stream |
Список кодов состояния ответа, соответствующий текст HttpOperationResponse которого должен рассматриваться как поток. |
timeout | Количество миллисекундах, которые может занять запрос до автоматического завершения.
Если запрос завершается, |
url | URL-адрес, к которым обращается запрос. |
with |
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. |
Методы
clone() | Клонируйте этот объект запроса. |
prepare(unknown) | Это no-op для целей совместимости и будет вызываться при вызове. |
validate |
Проверяет, определены ли обязательные свойства, такие как 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
onDownloadProgress
Обратный вызов, который срабатывает при скачивании.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
onUploadProgress
Обратный вызов, который запускается при выполнении отправки.
onUploadProgress?: (progress: TransferProgressEvent) => void
Значение свойства
(progress: TransferProgressEvent) => void
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()
prepare(unknown)
Это no-op для целей совместимости и будет вызываться при вызове.
function prepare(options: unknown): WebResourceLike
Параметры
- options
-
unknown
Возвращаемое значение
validateRequestProperties()
Проверяет, определены ли обязательные свойства, такие как method, URL, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, это приведет к ошибке. Примечание. Это no-op в целях совместимости.
function validateRequestProperties()