PipelineRequest interface
Metaadatok a folyamat által küldött kérésről.
Tulajdonságok
| abort |
A kérés későbbi megszakítására szolgál. |
| agent | CSAK NODEJS Csak csomópontos beállítás egyéni |
| allow |
Igaz értékre van állítva, ha a kérés HTTP-en keresztül van elküldve HTTPS helyett |
| body | A HTTP-törzs tartalma (ha van ilyen) |
| disable |
Ha a kapcsolatot nem szabad újra felhasználni. |
| enable |
CSAK BÖNGÉSZŐ A böngésző streamjeinek engedélyezésére csak a böngészőben van lehetőség. Ha ez a beállítás be van állítva, és a válasz egy stream, akkor a válasz tulajdonsága Az alapértelmezett érték hamis |
| form |
Böngészőűrlap-bejegyzés szimulálása |
| headers | A kérés során használandó HTTP-fejlécek. |
| method | A kérés végrehajtásakor használandó HTTP-metódus. |
| multipart |
Többrészes kérelem törzse. |
| 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 |
Proxykonfiguráció. |
| request |
A kérés egyedi azonosítója. Naplózáshoz és nyomkövetéshez használatos. |
| request |
A kéréshez beállítható további beállítások. Ez lehetővé teszi a meglévők felülbírálását, vagy a nem deklarált kérelemtulajdonságok biztosítását. A lehetséges érvényes tulajdonságokért lásd:
FIGYELMEZTETÉS: Az itt megadott beállítások felülbírálják az azonos nevű tulajdonságokat, amikor a kérést a HttpClient küldi. |
| stream |
Azon válaszállapot-kódok listája, amelyek megfelelő PipelineResponse törzsét streamként kell kezelni. Ha a streamResponseStatusCodes tartalmazza az értéket, Number.POSITIVE_INFINITY bármilyen állapot streamként lesz kezelve. |
| timeout | A kérelmek automatikus leállása előtt eltartható ezredmásodperc.
Ha a kérelem le van állítva, a |
| tls |
A TLS-hitelesítés konfigurálásának beállításai |
| tracing |
A létrehozott spanok nyomkövetési beállításai. |
| url | A kérés kérésének URL-címe. |
| with |
Azt jelzi, hogy a felhasználói ügynök küldjön-e cookie-kat a másik tartományból keresztirányú kérések esetén. 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
agent
CSAK NODEJS
Csak csomópontos beállítás egyéni http.Agent/https.Agent.
Nem tesz semmit a böngészőben való futtatáskor.
agent?: Agent
Tulajdonság értéke
allowInsecureConnection
Igaz értékre van állítva, ha a kérés HTTP-en keresztül van elküldve HTTPS helyett
allowInsecureConnection?: boolean
Tulajdonság értéke
boolean
body
disableKeepAlive
Ha a kapcsolatot nem szabad újra felhasználni.
disableKeepAlive?: boolean
Tulajdonság értéke
boolean
enableBrowserStreams
CSAK BÖNGÉSZŐ
A böngésző streamjeinek engedélyezésére csak a böngészőben van lehetőség. Ha ez a beállítás be van állítva, és a válasz egy stream, akkor a válasz tulajdonsága browserStream lesz a nem definiált blobBody helyett.
Az alapértelmezett érték hamis
enableBrowserStreams?: boolean
Tulajdonság értéke
boolean
formData
headers
method
A kérés végrehajtásakor használandó HTTP-metódus.
method: HttpMethods
Tulajdonság értéke
multipartBody
Többrészes kérelem törzse.
multipartBody?: MultipartRequestBody
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
requestOverrides
A kéréshez beállítható további beállítások. Ez lehetővé teszi a meglévők felülbírálását, vagy a nem deklarált kérelemtulajdonságok biztosítását.
A lehetséges érvényes tulajdonságokért lásd:
- NodeJS https.request beállításai: https://nodejs.org/api/http.html#httprequestoptions-callback
- Böngésző RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
FIGYELMEZTETÉS: Az itt megadott beállítások felülbírálják az azonos nevű tulajdonságokat, amikor a kérést a HttpClient küldi.
requestOverrides?: Record<string, unknown>
Tulajdonság értéke
Record<string, unknown>
streamResponseStatusCodes
Azon válaszállapot-kódok listája, amelyek megfelelő PipelineResponse törzsét streamként kell kezelni. Ha a streamResponseStatusCodes tartalmazza az értéket, Number.POSITIVE_INFINITY bármilyen állapot streamként lesz kezelve.
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
tlsSettings
A TLS-hitelesítés konfigurálásának beállításai
tlsSettings?: TlsSettings
Tulajdonság értéke
tracingOptions
A létrehozott spanok nyomkövetési beállításai.
tracingOptions?: OperationTracingOptions
Tulajdonság értéke
url
A kérés kérésének URL-címe.
url: string
Tulajdonság értéke
string
withCredentials
Azt jelzi, hogy a felhasználói ügynök küldjön-e cookie-kat a másik tartományból keresztirányú kérések esetén. Alapértelmezés szerint hamis.
withCredentials: boolean
Tulajdonság értéke
boolean