WebResourceLike interface
REST-hívás absztrakciója.
Tulajdonságok
abort |
A kérés későbbi megszakítására szolgál. |
agent |
HTTP-ügynök konfigurációja. |
body | A kérelem HTTP-törzsének tartalma. |
form |
|
headers | A kérés során használandó HTTP-fejlécek. |
keep |
Ha a kapcsolatot újra fel kell használni. |
method | A kérés végrehajtásakor használandó HTTP-metódus. |
on |
Visszahívás, amely a letöltési folyamat során aktiválódik. |
on |
Visszahívás, amely a feltöltési folyamat során aktiválódik. |
operation |
Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva. |
operation |
A válasz elemzésére szolgál. |
proxy |
Proxykonfiguráció. |
query | Objektumként ábrázolt lekérdezési sztring. |
redirect |
A kéréshez követett átirányítások számának korlátozása. Ha 0 értékre van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése érvényes lesz. |
should |
Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell. |
stream |
Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni. |
timeout | A kérelmek automatikus leállása előtt eltartható ezredmásodperc.
Ha a kérelem le van állítva, a |
url | A kérés által elért URL-cím. |
with |
Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni. |
Metódusok
clone() | Klónozza ezt a kérésobjektumot. |
prepare(Request |
Beállítja a kérés beállításait. |
validate |
Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva. |
Tulajdonság adatai
abortSignal
A kérés későbbi megszakítására szolgál.
abortSignal?: AbortSignalLike
Tulajdonság értéke
agentSettings
body
A kérelem HTTP-törzsének tartalma.
body?: any
Tulajdonság értéke
any
formData
formData?: any
Tulajdonság értéke
any
headers
A kérés során használandó HTTP-fejlécek.
headers: HttpHeadersLike
Tulajdonság értéke
keepAlive
Ha a kapcsolatot újra fel kell használni.
keepAlive?: boolean
Tulajdonság értéke
boolean
method
A kérés végrehajtásakor használandó HTTP-metódus.
method: HttpMethods
Tulajdonság értéke
onDownloadProgress
Visszahívás, amely a letöltési folyamat során aktiválódik.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Tulajdonság értéke
(progress: TransferProgressEvent) => void
onUploadProgress
Visszahívás, amely a feltöltési folyamat során aktiválódik.
onUploadProgress?: (progress: TransferProgressEvent) => void
Tulajdonság értéke
(progress: TransferProgressEvent) => void
operationResponseGetter
Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
Tulajdonság értéke
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
Objektumként ábrázolt lekérdezési sztring.
query?: {[key: string]: any}
Tulajdonság értéke
{[key: string]: any}
redirectLimit
A kéréshez követett átirányítások számának korlátozása. Ha 0 értékre van állítva, az átirányítások nem lesznek követve. Ha nincs meghatározva, a mögöttes node_fetch alapértelmezett átirányítási viselkedése érvényes lesz.
redirectLimit?: number
Tulajdonság értéke
number
shouldDeserialize
Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
Tulajdonság értéke
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
streamResponseBody?: boolean
Tulajdonság értéke
boolean
timeout
A kérelmek automatikus leállása előtt eltartható ezredmásodperc.
Ha a kérelem le van állítva, a AbortError
adódik.
timeout: number
Tulajdonság értéke
number
url
A kérés által elért URL-cím.
url: string
Tulajdonság értéke
string
withCredentials
Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni.
withCredentials: boolean
Tulajdonság értéke
boolean
Metódus adatai
clone()
prepare(RequestPrepareOptions)
Beállítja a kérés beállításait.
function prepare(options: RequestPrepareOptions): WebResourceLike
Paraméterek
- options
- RequestPrepareOptions
Válaszok
validateRequestProperties()
Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva.
function validateRequestProperties()