WebResourceLike interface

Pacchetto:

@azure/ms-rest-js

Astrazione su una chiamata REST.

Proprietà

abortSignal	Usato per interrompere la richiesta in un secondo momento.
agentSettings	Configurazione dell'agente HTTP(S).
body	Contenuto del corpo HTTP della richiesta.
formData
headers	Intestazioni HTTP da usare durante l'esecuzione della richiesta.
keepAlive	Se la connessione deve essere riutilizzata.
method	Metodo HTTP da usare durante l'esecuzione della richiesta.
onDownloadProgress	Callback attivato al momento dell'avanzamento del download.
onUploadProgress	Callback attivato al momento del caricamento.
operationResponseGetter	Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse specificata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.
operationSpec	Usato per analizzare la risposta.
proxySettings	Configurazione del proxy.
query	Stringa di query rappresentata come oggetto .
redirectLimit	Limitare il numero di reindirizzamenti seguiti per questa richiesta. Se impostato su 0, i reindirizzamenti non verranno seguiti. Se non definito, verrà applicato il comportamento di reindirizzamento predefinito del node_fetch sottostante.
shouldDeserialize	Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
streamResponseBody	Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso.
timeout	Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata un'eccezione AbortError .
url	URL a cui si accede dalla richiesta.
withCredentials	Se le credenziali (cookie) devono essere inviate durante un XHR.

Metodi

clone()	Clonare questo oggetto richiesta.
prepare(RequestPrepareOptions)	Imposta le opzioni nella richiesta.
validateRequestProperties()	Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita.

Dettagli proprietà

abortSignal

Usato per interrompere la richiesta in un secondo momento.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

agentSettings

Configurazione dell'agente HTTP(S).

agentSettings?: AgentSettings

Valore della proprietà

AgentSettings

body

Contenuto del corpo HTTP della richiesta.

body?: any

Valore della proprietà

any

formData

formData?: any

Valore della proprietà

any

headers

Intestazioni HTTP da usare durante l'esecuzione della richiesta.

headers: HttpHeadersLike

Valore della proprietà

HttpHeadersLike

keepAlive

Se la connessione deve essere riutilizzata.

keepAlive?: boolean

Valore della proprietà

boolean

method

Metodo HTTP da usare durante l'esecuzione della richiesta.

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress

Callback attivato al momento dell'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback attivato al momento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse specificata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.

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

Valore della proprietà

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

operationSpec

Usato per analizzare la risposta.

operationSpec?: OperationSpec

Valore della proprietà

OperationSpec

proxySettings

Configurazione del proxy.

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

query

Stringa di query rappresentata come oggetto .

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

Valore della proprietà

{[key: string]: any}

redirectLimit

Limitare il numero di reindirizzamenti seguiti per questa richiesta. Se impostato su 0, i reindirizzamenti non verranno seguiti. Se non definito, verrà applicato il comportamento di reindirizzamento predefinito del node_fetch sottostante.

redirectLimit?: number

Valore della proprietà

number

shouldDeserialize

Indica se httpOperationResponse deve essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.

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

Valore della proprietà

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Indica se il corpo di HttpOperationResponse deve essere considerato come un flusso.

streamResponseBody?: boolean

Valore della proprietà

boolean

timeout

Il numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente. Se la richiesta viene terminata, viene generata un'eccezione AbortError .

timeout: number

Valore della proprietà

number

url

URL a cui si accede dalla richiesta.

url: string

Valore della proprietà

string

withCredentials

Se le credenziali (cookie) devono essere inviate durante un XHR.

withCredentials: boolean

Valore della proprietà

boolean

Dettagli metodo

clone()

Clonare questo oggetto richiesta.

function clone(): WebResourceLike

Restituisce

WebResourceLike

prepare(RequestPrepareOptions)

Imposta le opzioni nella richiesta.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametri

options

RequestPrepareOptions

Restituisce

WebResourceLike

validateRequestProperties()

Verifica che siano definite le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], intestazioni["accept-language"]. Verrà generato un errore se una delle proprietà indicate in precedenza non è definita.

function validateRequestProperties()