Partager via

WebResourceLike interface

  • Référence
Paquet:
@azure/ms-rest-js

Abstraction sur un appel REST.

Propriétés

abortSignal

Utilisé pour abandonner la requête ultérieurement.
agentSettings

Configuration de l’agent HTTP(S).
body

Contenu du corps HTTP de la requête.
formData
headers

En-têtes HTTP à utiliser lors de la requête.
keepAlive

Si la connexion doit être réutilisée.
method

Méthode HTTP à utiliser lors de l’établissement de la requête.
onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.
operationResponseGetter

Fonction qui retourne la valeur OperationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. S’il n’est pas défini, une recherche de code d’état simple sera utilisée.
operationSpec

Utilisé pour analyser la réponse.
proxySettings

Configuration du proxy.
query

Chaîne de requête représentée en tant qu’objet.
redirectLimit

Limitez le nombre de redirections suivies pour cette requête. Si la valeur est 0, les redirections ne sont pas suivies. Si elle n’est pas définie, le comportement de redirection par défaut du node_fetch sous-jacent s’applique.
shouldDeserialize

Indique si HttpOperationResponse doit être désérialisé ou non. S’il n’est pas défini, httpOperationResponse doit être désérialisé.
streamResponseBody

Indique si le corps de HttpOperationResponse doit être traité comme un flux.
timeout

Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée.
url

URL accessible par la requête.
withCredentials

Si les informations d’identification (cookies) doivent être envoyées pendant un XHR.

Méthodes

clone()

Clonez cet objet de requête.
prepare(RequestPrepareOptions)

Définit les options de la requête.
validateRequestProperties()

Valide que les propriétés requises, telles que la méthode, l’URL, les en-têtes["Content-Type"], les en-têtes["accept-language"] sont définis. Elle génère une erreur si l’une des propriétés mentionnées ci-dessus n’est pas définie.

Détails de la propriété

abortSignal

Utilisé pour abandonner la requête ultérieurement.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

agentSettings

Configuration de l’agent HTTP(S).

agentSettings?: AgentSettings

Valeur de propriété

AgentSettings

body

Contenu du corps HTTP de la requête.

body?: any

Valeur de propriété

any

formData 

formData?: any

Valeur de propriété

any

headers

En-têtes HTTP à utiliser lors de la requête.

headers: HttpHeadersLike

Valeur de propriété

HttpHeadersLike

keepAlive

Si la connexion doit être réutilisée.

keepAlive?: boolean

Valeur de propriété

boolean

method

Méthode HTTP à utiliser lors de l’établissement de la requête.

method: HttpMethods

Valeur de propriété

HttpMethods

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

operationResponseGetter

Fonction qui retourne la valeur OperationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. S’il n’est pas défini, une recherche de code d’état simple sera utilisée.

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

Valeur de propriété

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

operationSpec

Utilisé pour analyser la réponse.

operationSpec?: OperationSpec

Valeur de propriété

OperationSpec

proxySettings

Configuration du proxy.

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

query

Chaîne de requête représentée en tant qu’objet.

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

Valeur de propriété

{[key: string]: any}

redirectLimit

Limitez le nombre de redirections suivies pour cette requête. Si la valeur est 0, les redirections ne sont pas suivies. Si elle n’est pas définie, le comportement de redirection par défaut du node_fetch sous-jacent s’applique.

redirectLimit?: number

Valeur de propriété

number

shouldDeserialize

Indique si HttpOperationResponse doit être désérialisé ou non. S’il n’est pas défini, httpOperationResponse doit être désérialisé.

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

Valeur de propriété

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Indique si le corps de HttpOperationResponse doit être traité comme un flux.

streamResponseBody?: boolean

Valeur de propriété

boolean

timeout

Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement. Si la demande est terminée, une AbortError est levée.

timeout: number

Valeur de propriété

number

url

URL accessible par la requête.

url: string

Valeur de propriété

string

withCredentials

Si les informations d’identification (cookies) doivent être envoyées pendant un XHR.

withCredentials: boolean

Valeur de propriété

boolean

Détails de la méthode

clone()

Clonez cet objet de requête.

function clone(): WebResourceLike

Retours

WebResourceLike

prepare(RequestPrepareOptions)

Définit les options de la requête.

function prepare(options: RequestPrepareOptions): WebResourceLike

Paramètres

options
RequestPrepareOptions

Retours

WebResourceLike

validateRequestProperties()

Valide que les propriétés requises, telles que la méthode, l’URL, les en-têtes["Content-Type"], les en-têtes["accept-language"] sont définis. Elle génère une erreur si l’une des propriétés mentionnées ci-dessus n’est pas définie.

function validateRequestProperties()