WebResourceLike interface

Pacote:

@azure/ms-rest-js

Uma abstração em uma chamada REST.

Propriedades

abortSignal	Usado para anular a solicitação posteriormente.
agentSettings	Configuração do agente HTTP(S).
body	O conteúdo do corpo HTTP da solicitação.
formData
headers	Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
keepAlive	Se a conexão deve ser reutilizado.
method	O método HTTP a ser usado ao fazer a solicitação.
onDownloadProgress	Retorno de chamada que é acionado após o progresso do download.
onUploadProgress	Retorno de chamada que é acionado após o progresso do upload.
operationResponseGetter	Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.
operationSpec	Usado para analisar a resposta.
proxySettings	Configuração de proxy.
query	Uma cadeia de caracteres de consulta representada como um objeto .
redirectLimit	Limite o número de redirecionamentos seguidos para essa solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se deixado indefinido, o comportamento de redirecionamento padrão da node_fetch subjacente será aplicado.
shouldDeserialize	Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.
streamResponseBody	Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.
timeout	O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, um AbortError será gerado.
url	A URL que está sendo acessada pela solicitação.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

clone()	Clone esse objeto de solicitação.
prepare(RequestPrepareOptions)	Define as opções na solicitação.
validateRequestProperties()	Valida se as propriedades necessárias, como método, URL, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] estão definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida.

Detalhes da propriedade

abortSignal

Usado para anular a solicitação posteriormente.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

agentSettings

Configuração do agente HTTP(S).

agentSettings?: AgentSettings

Valor da propriedade

AgentSettings

body

O conteúdo do corpo HTTP da solicitação.

body?: any

Valor da propriedade

any

formData

formData?: any

Valor da propriedade

any

headers

Os cabeçalhos HTTP a serem usados ao fazer a solicitação.

headers: HttpHeadersLike

Valor da propriedade

HttpHeadersLike

keepAlive

Se a conexão deve ser reutilizado.

keepAlive?: boolean

Valor da propriedade

boolean

method

O método HTTP a ser usado ao fazer a solicitação.

method: HttpMethods

Valor da propriedade

HttpMethods

onDownloadProgress

Retorno de chamada que é acionado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Retorno de chamada que é acionado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.

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

Valor da propriedade

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

operationSpec

Usado para analisar a resposta.

operationSpec?: OperationSpec

Valor da propriedade

OperationSpec

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

query

Uma cadeia de caracteres de consulta representada como um objeto .

query?: {[key: string]: any}

Valor da propriedade

{[key: string]: any}

redirectLimit

Limite o número de redirecionamentos seguidos para essa solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se deixado indefinido, o comportamento de redirecionamento padrão da node_fetch subjacente será aplicado.

redirectLimit?: number

Valor da propriedade

number

shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor da propriedade

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.

streamResponseBody?: boolean

Valor da propriedade

boolean

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, um AbortError será gerado.

timeout: number

Valor da propriedade

number

url

A URL que está sendo acessada pela solicitação.

url: string

Valor da propriedade

string

withCredentials

Se as credenciais (cookies) devem ser enviadas durante um XHR.

withCredentials: boolean

Valor da propriedade

boolean

Detalhes do método

clone()

Clone esse objeto de solicitação.

function clone(): WebResourceLike

Retornos

WebResourceLike

prepare(RequestPrepareOptions)

Define as opções na solicitação.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parâmetros

options

RequestPrepareOptions

Retornos

WebResourceLike

validateRequestProperties()

Valida se as propriedades necessárias, como método, URL, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] estão definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()