WebResourceLike interface

Pacote:

@azure/ms-rest-js

Uma abstração sobre uma chamada REST.

Propriedades

abortSignal	Utilizado para abortar o pedido mais tarde.
agentSettings	Configuração do agente HTTP(S).
body	O conteúdo do corpo HTTP do pedido.
formData
headers	Os cabeçalhos HTTP a utilizar ao fazer o pedido.
keepAlive	Se a ligação tiver de ser reutilizada.
method	O método HTTP a utilizar ao fazer o pedido.
onDownloadProgress	Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress	Chamada de retorno que é acionada após o progresso do carregamento.
operationResponseGetter	Uma função que devolve a operação OperationResponse adequada para a combinação OperationSpec e HttpOperationResponse especificada. Se for indefinido, será utilizada uma pesquisa de código de estado simples.
operationSpec	Utilizado para analisar a resposta.
proxySettings	Configuração do proxy.
query	Uma cadeia de consulta representada como um objeto.
redirectLimit	Limite o número de redirecionamentos seguidos para este pedido. Se estiver definido como 0, os redirecionamentos não serão seguidos. Se não for definido, será aplicado o comportamento de redirecionamento predefinido do node_fetch subjacente.
shouldDeserialize	Se o HttpOperationResponse deve ou não ser desserializado. Se 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 um pedido pode tomar antes de ser terminado automaticamente. Se o pedido for terminado, é emitido um AbortError .
url	O URL que está a ser acedido pelo pedido.
withCredentials	Se as credenciais (cookies) forem enviadas durante um XHR.

Métodos

clone()	Clone este objeto de pedido.
prepare(RequestPrepareOptions)	Define as opções no pedido.
validateRequestProperties()	Valida que as propriedades necessárias, como método, URL, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] são definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

Detalhes de Propriedade

abortSignal

Utilizado para abortar o pedido 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 do pedido.

body?: any

Valor de Propriedade

any

formData

formData?: any

Valor de Propriedade

any

headers

Os cabeçalhos HTTP a utilizar ao fazer o pedido.

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive

Se a ligação tiver de ser reutilizada.

keepAlive?: boolean

Valor de Propriedade

boolean

method

O método HTTP a utilizar ao fazer o pedido.

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

Uma função que devolve a operação OperationResponse adequada para a combinação OperationSpec e HttpOperationResponse especificada. Se for indefinido, será utilizada uma pesquisa de código de estado simples.

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

Valor de Propriedade

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

operationSpec

Utilizado para analisar a resposta.

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings

Configuração do proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Uma cadeia 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 este pedido. Se estiver definido como 0, os redirecionamentos não serão seguidos. Se não for definido, será aplicado 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 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 um pedido pode tomar antes de ser terminado automaticamente. Se o pedido for terminado, é emitido um AbortError .

timeout: number

Valor de Propriedade

number

url

O URL que está a ser acedido pelo pedido.

url: string

Valor de Propriedade

string

withCredentials

Se as credenciais (cookies) forem enviadas durante um XHR.

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de pedido.

function clone(): WebResourceLike

Devoluções

WebResourceLike

prepare(RequestPrepareOptions)

Define as opções no pedido.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parâmetros

options

RequestPrepareOptions

Devoluções

WebResourceLike

validateRequestProperties()

Valida que as propriedades necessárias, como método, URL, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] são definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()