WebResource interface
Een beschrijving van een HTTP-aanvraag die moet worden gedaan op een externe server.
Eigenschappen
abort |
Signaal van een afgebroken controller. Kan worden gebruikt om het verzenden van een netwerkaanvraag af te breken en te wachten op een antwoord. |
agent | ALLEEN NODEJS Een optie voor alleen knooppunten om een aangepaste |
body | De inhoud van de HTTP-hoofdtekst van de aanvraag. |
decompress |
Of u het antwoord al dan niet wilt decomprimeren volgens Accept-Encoding header (alleen node-fetch) |
form |
Formuliergegevens, die worden gebruikt om de hoofdtekst van de aanvraag te bouwen. |
headers | De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag. |
keep |
Als de verbinding opnieuw moet worden gebruikt. |
method | De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag. |
on |
Callback die wordt geactiveerd bij de voortgang van het downloaden. |
on |
Callback die wordt geactiveerd bij het uploaden. |
proxy |
Proxyconfiguratie. |
query | Een querytekenreeks die wordt weergegeven als een object. |
request |
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering. |
stream |
Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld. |
stream |
Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stream. |
timeout | Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt er een |
url | De URL die wordt geopend door de aanvraag. |
with |
Als referenties (cookies) tijdens een XHR moeten worden verzonden. |
Methoden
clone() | Kloon dit aanvraagobject. |
prepare(unknown) | Dit is een no-op voor compat doeleinden en zal gooien als gebeld. |
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. Opmerking: dit is een no-op voor compatibiliteitsdoeleinden. |
Eigenschapdetails
abortSignal
Signaal van een afgebroken controller. Kan worden gebruikt om het verzenden van een netwerkaanvraag af te breken en te wachten op een antwoord.
abortSignal?: AbortSignalLike
Waarde van eigenschap
agent
ALLEEN NODEJS
Een optie voor alleen knooppunten om een aangepaste http.Agent
/https.Agent
op te geven.
OPMERKING: meestal moet dit één exemplaar zijn dat wordt gedeeld door meerdere aanvragen, zodat de onderliggende verbinding met de service opnieuw kan worden gebruikt.
Doet niets wanneer deze wordt uitgevoerd in de browser.
agent?: Agent
Waarde van eigenschap
body
De inhoud van de HTTP-hoofdtekst van de aanvraag.
body?: any
Waarde van eigenschap
any
decompressResponse
Of u het antwoord al dan niet wilt decomprimeren volgens Accept-Encoding header (alleen node-fetch)
decompressResponse?: boolean
Waarde van eigenschap
boolean
formData
Formuliergegevens, die worden gebruikt om de hoofdtekst van de aanvraag te bouwen.
formData?: any
Waarde van eigenschap
any
headers
De HTTP-headers die moeten worden gebruikt bij het indienen van de aanvraag.
headers: HttpHeadersLike
Waarde van eigenschap
keepAlive
Als de verbinding opnieuw moet worden gebruikt.
keepAlive?: boolean
Waarde van eigenschap
boolean
method
De HTTP-methode die moet worden gebruikt bij het indienen van de aanvraag.
method: HttpMethods
Waarde van eigenschap
onDownloadProgress
Callback die wordt geactiveerd bij de voortgang van het downloaden.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
onUploadProgress
Callback die wordt geactiveerd bij het uploaden.
onUploadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
proxySettings
query
Een querytekenreeks die wordt weergegeven als een object.
query?: {[key: string]: any}
Waarde van eigenschap
{[key: string]: any}
requestId
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
requestId: string
Waarde van eigenschap
string
streamResponseBody
Waarschuwing
Deze API is nu afgeschaft.
Use streamResponseStatusCodes property instead.
Of de hoofdtekst van de HttpOperationResponse al dan niet als een stream moet worden behandeld.
streamResponseBody?: boolean
Waarde van eigenschap
boolean
streamResponseStatusCodes
Een lijst met antwoordstatuscodes waarvan de bijbehorende hoofdtekst HttpOperationResponse moet worden behandeld als een stream.
streamResponseStatusCodes?: Set<number>
Waarde van eigenschap
Set<number>
timeout
Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt er een AbortError
gegenereerd.
timeout: number
Waarde van eigenschap
number
url
De URL die wordt geopend door de aanvraag.
url: string
Waarde van eigenschap
string
withCredentials
Als referenties (cookies) tijdens een XHR moeten worden verzonden.
withCredentials: boolean
Waarde van eigenschap
boolean
Methodedetails
clone()
prepare(unknown)
Dit is een no-op voor compat doeleinden en zal gooien als gebeld.
function prepare(options: unknown): WebResourceLike
Parameters
- options
-
unknown
Retouren
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. Opmerking: dit is een no-op voor compatibiliteitsdoeleinden.
function validateRequestProperties()