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


WebResourceLike interface

Абстракция при вызове REST.

Свойства

abortSignal

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

agentSettings

Конфигурация агента HTTP(S).

body

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

formData
headers

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

keepAlive

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

method

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

onDownloadProgress

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

onUploadProgress

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

operationResponseGetter

Функция, возвращающая правильное значение OperationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния.

operationSpec

Используется для анализа ответа.

proxySettings

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

query

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

redirectLimit

Ограничьте количество перенаправлений для этого запроса. Если задано значение 0, перенаправления не будут следовать. Если этот параметр не определен, будет применяться поведение перенаправления по умолчанию для базового node_fetch.

shouldDeserialize

Указывает, следует ли десериализовать httpOperationResponse. Если этот параметр не определен, необходимо десериализировать httpOperationResponse.

streamResponseBody

Указывает, следует ли обрабатывать тело HttpOperationResponse как поток.

timeout

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

url

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

withCredentials

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

Методы

clone()

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

prepare(RequestPrepareOptions)

Задает параметры запроса.

validateRequestProperties()

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

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

abortSignal

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

abortSignal?: AbortSignalLike

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

agentSettings

Конфигурация агента HTTP(S).

agentSettings?: AgentSettings

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

body

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

body?: any

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

any

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

operationResponseGetter

Функция, возвращающая правильное значение OperationResponse для заданного сочетания OperationSpec и HttpOperationResponse. Если это не определено, будет использоваться простой поиск кода состояния.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

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

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Используется для анализа ответа.

operationSpec?: OperationSpec

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

proxySettings

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

proxySettings?: 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

Параметры

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

validateRequestProperties()

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

function validateRequestProperties()