WebResource interface

Paquet:

@azure/storage-queue

Description d’une requête HTTP à effectuer sur un serveur distant.

Propriétés

abortSignal	Signal d’un contrôleur d’abandon. Peut être utilisé pour abandonner à la fois l’envoi d’une demande réseau et l’attente d’une réponse.
agent	NODEJS UNIQUEMENT Option Node uniquement pour fournir une http.Agent/https.Agentpersonnalisée. REMARQUE : généralement, il doit s’agir d’une instance partagée par plusieurs requêtes afin que la connexion sous-jacente au service puisse être réutilisée. Ne fait rien lors de l’exécution dans le navigateur.
body	Contenu du corps HTTP de la requête.
decompressResponse	Indique s’il faut décompresser ou non la réponse en fonction de l’en-tête Accept-Encoding (node-fetch uniquement)
formData	Données de formulaire, utilisées pour générer le corps de la requête.
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.
proxySettings	Configuration du proxy.
query	Chaîne de requête représentée en tant qu’objet.
requestId	Identificateur unique de la requête. Utilisé pour la journalisation et le suivi.
streamResponseBody	Indique si le corps de HttpOperationResponse doit être traité comme un flux.
streamResponseStatusCodes	Liste des codes d’état de réponse dont le corps HttpOperationResponse correspondant 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(unknown)	Il s’agit d’une no-op à des fins de compatibilité et lève si elle est appelée.
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. Remarque : il s’agit d’un no-op à des fins de compatibilité.

Détails de la propriété

abortSignal

Signal d’un contrôleur d’abandon. Peut être utilisé pour abandonner à la fois l’envoi d’une demande réseau et l’attente d’une réponse.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

agent

NODEJS UNIQUEMENT

Option Node uniquement pour fournir une http.Agent/https.Agentpersonnalisée. REMARQUE : généralement, il doit s’agir d’une instance partagée par plusieurs requêtes afin que la connexion sous-jacente au service puisse être réutilisée. Ne fait rien lors de l’exécution dans le navigateur.

agent?: Agent

Valeur de propriété

Agent

body

Contenu du corps HTTP de la requête.

body?: any

Valeur de propriété

any

decompressResponse

Indique s’il faut décompresser ou non la réponse en fonction de l’en-tête Accept-Encoding (node-fetch uniquement)

decompressResponse?: boolean

Valeur de propriété

boolean

formData

Données de formulaire, utilisées pour générer le corps de la requête.

formData?: any

Valeur de propriété

any

headers

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

headers: HttpHeadersLike

Valeur de propriété

HttpHeaders

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

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}

requestId

Identificateur unique de la requête. Utilisé pour la journalisation et le suivi.

requestId: string

Valeur de propriété

string

streamResponseBody

Avertissement

Cette API est à présent déconseillée.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Valeur de propriété

boolean

streamResponseStatusCodes

Liste des codes d’état de réponse dont le corps HttpOperationResponse correspondant doit être traité comme un flux.

streamResponseStatusCodes?: Set<number>

Valeur de propriété

Set<number>

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

WebResource

prepare(unknown)

Il s’agit d’une no-op à des fins de compatibilité et lève si elle est appelée.

function prepare(options: unknown): WebResourceLike

Paramètres

options

unknown

Retours

WebResource

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. Remarque : il s’agit d’un no-op à des fins de compatibilité.

function validateRequestProperties()