WebResource class
Hiermee maakt u een nieuw WebResource-object.
Deze klasse biedt een abstractie over een REST-aanroep door bibliotheek-/implementatieneutraal te zijn en de benodigde eigenschappen te verpakken om een aanvraag te starten.
Constructors
Eigenschappen
| abort |
|
| agent |
|
| body | |
| form |
|
| headers | |
| keep |
|
| method | |
| on |
Callback die wordt geactiveerd bij de voortgang van het downloaden. |
| on |
Callback die wordt geactiveerd bij de uploadvoortgang. |
| operation |
Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes gebruikt. |
| operation |
|
| proxy |
|
| query | |
| redirect |
|
| should |
Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd. |
| stream |
Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom. |
| timeout | |
| url | |
| with |
Methoden
| clone() | Kloon dit WebResource HTTP-aanvraagobject. |
| prepare(Request |
Bereidt de aanvraag voor. |
| validate |
Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd. |
Constructordetails
WebResource(string, HttpMethods, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number)
new WebResource(url?: string, method?: HttpMethods, body?: any, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, agentSettings?: AgentSettings, redirectLimit?: number)Parameters
- url
-
string
- method
- HttpMethods
- body
-
any
- query
-
{[key: string]: any}
- headers
-
{[key: string]: any} | HttpHeadersLike
- streamResponseBody
-
boolean
- withCredentials
-
boolean
- abortSignal
- AbortSignalLike
- timeout
-
number
- onUploadProgress
-
(progress: TransferProgressEvent) => void
- onDownloadProgress
-
(progress: TransferProgressEvent) => void
- proxySettings
- ProxySettings
- keepAlive
-
boolean
- agentSettings
- AgentSettings
- redirectLimit
-
number
Eigenschapdetails
abortSignal
agentSettings
body
body?: anyWaarde van eigenschap
any
formData
formData?: anyWaarde van eigenschap
any
headers
keepAlive
keepAlive?: booleanWaarde van eigenschap
boolean
method
onDownloadProgress
Callback die wordt geactiveerd bij de voortgang van het downloaden.
onDownloadProgress?: (progress: TransferProgressEvent) => voidWaarde van eigenschap
(progress: TransferProgressEvent) => void
onUploadProgress
Callback die wordt geactiveerd bij de uploadvoortgang.
onUploadProgress?: (progress: TransferProgressEvent) => voidWaarde van eigenschap
(progress: TransferProgressEvent) => void
operationResponseGetter
Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes gebruikt.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseWaarde van eigenschap
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
query?: {[key: string]: any}Waarde van eigenschap
{[key: string]: any}
redirectLimit
redirectLimit?: numberWaarde van eigenschap
number
shouldDeserialize
Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanWaarde van eigenschap
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom.
streamResponseBody?: booleanWaarde van eigenschap
boolean
timeout
timeout: numberWaarde van eigenschap
number
url
url: stringWaarde van eigenschap
string
withCredentials
withCredentials: booleanWaarde van eigenschap
boolean
Methodedetails
clone()
Kloon dit WebResource HTTP-aanvraagobject.
function clone(): WebResourceRetouren
De kloon van dit WebResource HTTP-aanvraagobject.
prepare(RequestPrepareOptions)
Bereidt de aanvraag voor.
function prepare(options: RequestPrepareOptions): WebResourceParameters
- options
- RequestPrepareOptions
Opties voor het voorbereiden van de aanvraag.
Retouren
Retourneert het voorbereide WebResource-object (HTTP-aanvraag) dat moet worden opgegeven aan de aanvraagpijplijn.
validateRequestProperties()
Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.
function validateRequestProperties()