WebResourceLike interface

Pacote:

@azure/ms-rest-js

Uma abstração sobre uma chamada REST.

Propriedades

abortSignal	Usado para abortar a solicitação mais tarde.
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 reutilizada.
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 carregamento.
operationResponseGetter	Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse dada. Se isso não estiver definido, uma pesquisa simples de código de status 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 esta solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se não for definido, aplicar-se-á o comportamento de redirecionamento predefinido do node_fetch subjacente.
shouldDeserialize	Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deve 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, uma AbortError será lançada.
url	O URL que está sendo acessado pela solicitação.
withCredentials	Se as credenciais (cookies) devem ser enviadas durante um XHR.

Métodos

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

Detalhes de Propriedade

abortSignal

Usado para abortar a solicitação mais tarde.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

agentSettings

Configuração do agente HTTP(S).

agentSettings?: AgentSettings

Valor de Propriedade

AgentSettings

body

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

body?: any

Valor de Propriedade

any

formData

formData?: any

Valor de Propriedade

any

headers

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

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive

Se a conexão deve ser reutilizada.

keepAlive?: boolean

Valor de Propriedade

boolean

method

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

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

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

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

Valor de Propriedade

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

operationSpec

Usado para analisar a resposta.

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Uma cadeia de caracteres de consulta representada como um objeto.

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

Valor de Propriedade

{[key: string]: any}

redirectLimit

Limite o número de redirecionamentos seguidos para esta solicitação. Se definido como 0, os redirecionamentos não serão seguidos. Se não for definido, aplicar-se-á o comportamento de redirecionamento predefinido do node_fetch subjacente.

redirectLimit?: number

Valor de Propriedade

number

shouldDeserialize

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

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

Valor de Propriedade

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

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

streamResponseBody?: boolean

Valor de 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, uma AbortError será lançada.

timeout: number

Valor de Propriedade

number

url

O URL que está sendo acessado pela solicitação.

url: string

Valor de Propriedade

string

withCredentials

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

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de solicitação.

function clone(): WebResourceLike

Devoluções

WebResourceLike

prepare(RequestPrepareOptions)

Define opções na solicitação.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parâmetros

options

RequestPrepareOptions

Devoluções

WebResourceLike

validateRequestProperties()

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

function validateRequestProperties()