PipelineRequest interface
Metadane dotyczące żądania wykonywanego przez potok.
Właściwości
| abort |
Służy do przerwania żądania później. |
| agent | TYLKO NODEJS Opcja tylko dla węzła umożliwiająca podanie niestandardowego |
| allow |
Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS |
| body | Zawartość treści HTTP (jeśli istnieje) |
| disable |
Jeśli połączenie nie powinno być ponownie używane. |
| enable |
TYLKO PRZEGLĄDARKA Opcja przeglądarki tylko w celu włączenia strumieni przeglądarki. Jeśli ta opcja jest ustawiona, a odpowiedź jest strumieniem, odpowiedź będzie mieć właściwość Wartość domyślna to false |
| form |
Aby zasymulować wpis w formularzu przeglądarki |
| headers | Nagłówki HTTP do użycia podczas tworzenia żądania. |
| method | Metoda HTTP, która ma być używana podczas wykonywania żądania. |
| multipart |
Treść żądania wieloczęściowego. |
| on |
Wywołanie zwrotne uruchamiane po postępie pobierania. |
| on |
Wywołanie zwrotne uruchamiane po postępie przekazywania. |
| proxy |
Konfiguracja serwera proxy. |
| request |
Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia. |
| request |
Dodatkowe opcje do ustawienia na żądanie. Umożliwia to zastąpienie istniejących lub podanie właściwości żądania, które nie są zadeklarowane. Aby uzyskać informacje o możliwych prawidłowych właściwościach, zobacz
OSTRZEŻENIE: Opcje określone w tym miejscu zastąpią wszystkie właściwości o tych samych nazwach, gdy żądanie zostanie wysłane przez HttpClient. |
| stream |
Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse powinna być traktowana jako strumień. Gdy element streamResponseStatusCodes zawiera wartość Number.POSITIVE_INFINITY każdy stan będzie traktowany jako strumień. |
| timeout | Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem.
Jeśli żądanie zostanie zakończone, zostanie zgłoszony |
| tls |
Ustawienia konfigurowania uwierzytelniania TLS |
| tracing |
Opcje śledzenia do użycia dla dowolnych utworzonych spans. |
| url | Adres URL, do którego ma być skierowane żądanie. |
| with |
Wskazuje, czy agent użytkownika powinien wysyłać pliki cookie z innej domeny w przypadku żądań między źródłami. Wartość domyślna to false. |
Szczegóły właściwości
abortSignal
Służy do przerwania żądania później.
abortSignal?: AbortSignalLikeWartość właściwości
agent
TYLKO NODEJS
Opcja tylko dla węzła umożliwiająca podanie niestandardowego http.Agent/https.Agent.
Nie działa w przeglądarce.
agent?: AgentWartość właściwości
allowInsecureConnection
Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
allowInsecureConnection?: booleanWartość właściwości
boolean
body
disableKeepAlive
Jeśli połączenie nie powinno być ponownie używane.
disableKeepAlive?: booleanWartość właściwości
boolean
enableBrowserStreams
TYLKO PRZEGLĄDARKA
Opcja przeglądarki tylko w celu włączenia strumieni przeglądarki. Jeśli ta opcja jest ustawiona, a odpowiedź jest strumieniem, odpowiedź będzie mieć właściwość browserStream zamiast blobBody, która będzie niezdefiniowana.
Wartość domyślna to false
enableBrowserStreams?: booleanWartość właściwości
boolean
formData
Aby zasymulować wpis w formularzu przeglądarki
formData?: FormDataMapWartość właściwości
headers
Nagłówki HTTP do użycia podczas tworzenia żądania.
headers: HttpHeadersWartość właściwości
method
Metoda HTTP, która ma być używana podczas wykonywania żądania.
method: HttpMethodsWartość właściwości
multipartBody
Treść żądania wieloczęściowego.
multipartBody?: MultipartRequestBodyWartość właściwości
onDownloadProgress
Wywołanie zwrotne uruchamiane po postępie pobierania.
onDownloadProgress?: (progress: TransferProgressEvent) => voidWartość właściwości
(progress: TransferProgressEvent) => void
onUploadProgress
Wywołanie zwrotne uruchamiane po postępie przekazywania.
onUploadProgress?: (progress: TransferProgressEvent) => voidWartość właściwości
(progress: TransferProgressEvent) => void
proxySettings
requestId
Unikatowy identyfikator żądania. Służy do rejestrowania i śledzenia.
requestId: stringWartość właściwości
string
requestOverrides
Dodatkowe opcje do ustawienia na żądanie. Umożliwia to zastąpienie istniejących lub podanie właściwości żądania, które nie są zadeklarowane.
Aby uzyskać informacje o możliwych prawidłowych właściwościach, zobacz
- Opcje https.request NodeJS: https://nodejs.org/api/http.html#httprequestoptions-callback
- Przeglądarka RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
OSTRZEŻENIE: Opcje określone w tym miejscu zastąpią wszystkie właściwości o tych samych nazwach, gdy żądanie zostanie wysłane przez HttpClient.
requestOverrides?: Record<string, unknown>Wartość właściwości
Record<string, unknown>
streamResponseStatusCodes
Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse powinna być traktowana jako strumień. Gdy element streamResponseStatusCodes zawiera wartość Number.POSITIVE_INFINITY każdy stan będzie traktowany jako strumień.
streamResponseStatusCodes?: Set<number>Wartość właściwości
Set<number>
timeout
Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem.
Jeśli żądanie zostanie zakończone, zostanie zgłoszony AbortError.
Wartość domyślna to 0, co powoduje wyłączenie limitu czasu.
timeout: numberWartość właściwości
number
tlsSettings
Ustawienia konfigurowania uwierzytelniania TLS
tlsSettings?: TlsSettingsWartość właściwości
tracingOptions
Opcje śledzenia do użycia dla dowolnych utworzonych spans.
tracingOptions?: OperationTracingOptionsWartość właściwości
url
Adres URL, do którego ma być skierowane żądanie.
url: stringWartość właściwości
string
withCredentials
Wskazuje, czy agent użytkownika powinien wysyłać pliki cookie z innej domeny w przypadku żądań między źródłami. Wartość domyślna to false.
withCredentials: booleanWartość właściwości
boolean