WebResourceLike interface
En beskrivning av en HTTP-begäran som ska göras till en fjärrserver.
Egenskaper
| abort |
Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar. |
| body | HTTP-brödtextinnehållet i begäran. |
| decompress |
Om svaret ska dekomprimeras eller inte enligt Accept-Encoding sidhuvud (endast nodhämtning) |
| form |
Formulärdata som används för att skapa begärandetexten. |
| headers | DE HTTP-huvuden som ska användas när du gör begäran. |
| keep |
Om anslutningen ska återanvändas. |
| method | DEN HTTP-metod som ska användas när du gör begäran. |
| on |
Återanrop som utlöses vid nedladdningsframställning. |
| on |
Återanrop som utlöses vid uppladdningsstatus. |
| operation |
En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning. |
| operation |
Används för att parsa svaret. |
| proxy |
Proxykonfiguration. |
| query | En frågesträng som representeras som ett objekt. |
| request |
En unik identifierare för begäran. Används för loggning och spårning. |
| should |
Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras. |
| stream |
Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte. |
| stream |
En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en ström. |
| timeout | Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.
Om begäran avslutas utlöses en |
| tracing |
Spårning: Kontext som används när du skapar intervall. |
| url | URL:en som används av begäran. |
| with |
Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR. |
Metoder
| clone() | Klona det här begärandeobjektet. |
| prepare(Request |
Anger alternativ för begäran. |
| validate |
Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats. |
Egenskapsinformation
abortSignal
Signal för en avbruten styrenhet. Kan användas för att avbryta både skicka en nätverksbegäran och vänta på ett svar.
abortSignal?: AbortSignalLikeEgenskapsvärde
body
HTTP-brödtextinnehållet i begäran.
body?: anyEgenskapsvärde
any
decompressResponse
Om svaret ska dekomprimeras eller inte enligt Accept-Encoding sidhuvud (endast nodhämtning)
decompressResponse?: booleanEgenskapsvärde
boolean
formData
Formulärdata som används för att skapa begärandetexten.
formData?: anyEgenskapsvärde
any
headers
DE HTTP-huvuden som ska användas när du gör begäran.
headers: HttpHeadersLikeEgenskapsvärde
keepAlive
Om anslutningen ska återanvändas.
keepAlive?: booleanEgenskapsvärde
boolean
method
onDownloadProgress
Återanrop som utlöses vid nedladdningsframställning.
onDownloadProgress?: (progress: TransferProgressEvent) => voidEgenskapsvärde
(progress: TransferProgressEvent) => void
onUploadProgress
Återanrop som utlöses vid uppladdningsstatus.
onUploadProgress?: (progress: TransferProgressEvent) => voidEgenskapsvärde
(progress: TransferProgressEvent) => void
operationResponseGetter
En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseEgenskapsvärde
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
En frågesträng som representeras som ett objekt.
query?: {[key: string]: any}Egenskapsvärde
{[key: string]: any}
requestId
En unik identifierare för begäran. Används för loggning och spårning.
requestId: stringEgenskapsvärde
string
shouldDeserialize
Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanEgenskapsvärde
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Varning
Det här API:et är nu inaktuellt.
Use streamResponseStatusCodes property instead.
Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.
streamResponseBody?: booleanEgenskapsvärde
boolean
streamResponseStatusCodes
En lista över svarsstatuskoder vars motsvarande HttpOperationResponse-brödtext ska behandlas som en ström.
streamResponseStatusCodes?: Set<number>Egenskapsvärde
Set<number>
timeout
Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.
Om begäran avslutas utlöses en AbortError .
timeout: numberEgenskapsvärde
number
tracingContext
Spårning: Kontext som används när du skapar intervall.
tracingContext?: ContextEgenskapsvärde
url
URL:en som används av begäran.
url: stringEgenskapsvärde
string
withCredentials
Om autentiseringsuppgifter (cookies) ska skickas tillsammans under en XHR.
withCredentials: booleanEgenskapsvärde
boolean
Metodinformation
clone()
prepare(RequestPrepareOptions)
Anger alternativ för begäran.
function prepare(options: RequestPrepareOptions): WebResourceLikeParametrar
- options
- RequestPrepareOptions
Returer
validateRequestProperties()
Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.
function validateRequestProperties()