PipelineRequestOptions interface
A kérés inicializálásának beállításai. Majdnem egyenértékű a Partial<PipelineRequest-kel>, de az url kötelező.
Tulajdonságok
| abort |
A kérés későbbi megszakítására szolgál. |
| body | A HTTP-törzs tartalma (ha van ilyen) |
| form |
Böngészőűrlap-bejegyzés szimulálása |
| headers | A kérés során használandó HTTP-fejlécek. |
| keep |
Ha a kapcsolatot újra fel kell használni. Alapértelmezés szerint igaz. |
| 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. |
| proxy |
Proxy konfigurációja. |
| request |
A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használatos. |
| span |
A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van. |
| stream |
Azon válaszállapot-kódok listája, amelyek megfelelő PipelineResponse törzsét streamként kell 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 kérésének URL-címe. |
| with |
Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni. Alapértelmezés szerint hamis. |
Tulajdonság adatai
abortSignal
A kérés későbbi megszakítására szolgál.
abortSignal?: AbortSignalLike
Tulajdonság értéke
body
formData
headers
keepAlive
Ha a kapcsolatot újra fel kell használni. Alapértelmezés szerint igaz.
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
proxySettings
requestId
A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használatos.
requestId?: string
Tulajdonság értéke
string
spanOptions
A hatókör létrehozására szolgáló beállítások, ha a nyomkövetés engedélyezve van.
spanOptions?: SpanOptions
Tulajdonság értéke
streamResponseStatusCodes
Azon válaszállapot-kódok listája, amelyek megfelelő PipelineResponse törzsét streamként kell kezelni.
streamResponseStatusCodes?: Set<number>
Tulajdonság értéke
Set<number>
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.
Alapértelmezés szerint 0, ami letiltja az időtúllépést.
timeout?: number
Tulajdonság értéke
number
url
A kérés kérésének URL-címe.
url: string
Tulajdonság értéke
string
withCredentials
Ha a hitelesítő adatokat (cookie-kat) az XHR során kell elküldeni. Alapértelmezés szerint hamis.
withCredentials?: boolean
Tulajdonság értéke
boolean