WebResourceLike interface
Абстракция при вызове REST.
Свойства
abort |
Используется для прерывания запроса позже. |
agent |
Конфигурация агента HTTP(S). |
body | Содержимое текста HTTP запроса. |
form |
|
headers | Заголовки HTTP, используемые при выполнении запроса. |
keep |
Значение , если подключение следует использовать повторно. |
method | Метод HTTP, используемый при выполнении запроса. |
on |
Обратный вызов, который срабатывает при скачивании. |
on |
Обратный вызов, который запускается при выполнении отправки. |
operation |
Функция, возвращающая правильное значение OperationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния. |
operation |
Используется для анализа ответа. |
proxy |
Конфигурация прокси-сервера. |
query | Строка запроса, представленная в виде объекта . |
redirect |
Ограничьте количество перенаправлений для этого запроса. Если задано значение 0, перенаправления не будут следовать. Если этот параметр не определен, будет применяться поведение перенаправления по умолчанию для базового node_fetch. |
should |
Указывает, следует ли десериализовать httpOperationResponse. Если этот параметр не определен, необходимо десериализировать httpOperationResponse. |
stream |
Указывает, следует ли обрабатывать тело HttpOperationResponse как поток. |
timeout | Количество миллисекундах, которые может занять запрос до автоматического завершения.
Если запрос завершается, |
url | URL-адрес, к которым обращается запрос. |
with |
Если учетные данные (файлы cookie) должны быть отправлены во время XHR. |
Методы
clone() | Клонируйте этот объект запроса. |
prepare(Request |
Задает параметры запроса. |
validate |
Проверяет, определены ли обязательные свойства, такие как method, URL, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, это приведет к ошибке. |
Сведения о свойстве
abortSignal
Используется для прерывания запроса позже.
abortSignal?: AbortSignalLike
Значение свойства
agentSettings
body
Содержимое текста HTTP запроса.
body?: any
Значение свойства
any
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}
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
Возвращаемое значение
prepare(RequestPrepareOptions)
Задает параметры запроса.
function prepare(options: RequestPrepareOptions): WebResourceLike
Параметры
- options
- RequestPrepareOptions
Возвращаемое значение
validateRequestProperties()
Проверяет, определены ли обязательные свойства, такие как method, URL, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, это приведет к ошибке.
function validateRequestProperties()