WebResourceLike interface
Описание HTTP-запроса, который необходимо выполнить на удаленном сервере.
Свойства
| abort |
Сигнал контроллера прерывания. Можно использовать для прерывания отправки сетевого запроса и ожидания ответа. |
| body | Содержимое текста HTTP запроса. |
| decompress |
Следует ли декомпрессировать ответ в соответствии с заголовком Accept-Encoding (только узел-извлечение) |
| form |
Данные формы, используемые для создания текста запроса. |
| headers | Заголовки HTTP, используемые при выполнении запроса. |
| keep |
Если подключение должно использоваться повторно. |
| method | Метод HTTP, используемый при выполнении запроса. |
| on |
Обратный вызов, который запускается при выполнении скачивания. |
| on |
Обратный вызов, который запускается при выполнении отправки. |
| operation |
Функция, возвращающая правильное сочетание OperationResponse для заданной комбинации OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния. |
| operation |
Используется для анализа ответа. |
| proxy |
Конфигурация прокси-сервера. |
| query | Строка запроса, представленная как объект. |
| request |
Уникальный идентификатор запроса. Используется для ведения журнала и трассировки. |
| should |
Следует ли десериализировать httpOperationResponse. Если это не определено, необходимо десериализировать httpOperationResponse. |
| stream |
Следует ли рассматривать текст httpOperationResponse как поток. |
| stream |
Список кодов состояния ответа, соответствующий текст HttpOperationResponse, должен рассматриваться как поток. |
| timeout | Число миллисекундах запроса может приниматься перед автоматическим завершением.
Если запрос завершается, создается |
| tracing |
Трассировка: контекст, используемый при создании диапазонов. |
| url | URL-адрес, к которым обращается запрос. |
| with |
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. |
Методы
| clone() | Клонируйте этот объект запроса. |
| prepare(Request |
Задает параметры запроса. |
| validate |
Проверяет, определены ли обязательные свойства, такие как метод, URL-адрес, заголовки["Content-Type"], заголовки["accept-language"]. Это приведет к ошибке, если одно из указанных выше свойств не определено. |
Сведения о свойстве
abortSignal
Сигнал контроллера прерывания. Можно использовать для прерывания отправки сетевого запроса и ожидания ответа.
abortSignal?: AbortSignalLikeЗначение свойства
body
Содержимое текста HTTP запроса.
body?: anyЗначение свойства
any
decompressResponse
Следует ли декомпрессировать ответ в соответствии с заголовком Accept-Encoding (только узел-извлечение)
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
operationResponseGetter
Функция, возвращающая правильное сочетание OperationResponse для заданной комбинации OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseЗначение свойства
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
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Значение свойства
url
URL-адрес, к которым обращается запрос.
url: stringЗначение свойства
string
withCredentials
Если учетные данные (файлы cookie) должны быть отправлены во время XHR.
withCredentials: booleanЗначение свойства
boolean
Сведения о методе
clone()
Клонируйте этот объект запроса.
function clone(): WebResourceLikeВозвращаемое значение
prepare(RequestPrepareOptions)
Задает параметры запроса.
function prepare(options: RequestPrepareOptions): WebResourceLikeПараметры
- options
- RequestPrepareOptions
Возвращаемое значение
validateRequestProperties()
Проверяет, определены ли обязательные свойства, такие как метод, URL-адрес, заголовки["Content-Type"], заголовки["accept-language"]. Это приведет к ошибке, если одно из указанных выше свойств не определено.
function validateRequestProperties()