PipelineRequestOptions interface
Ustawienia inicjowania żądania. Prawie odpowiednik Partial<PipelineRequest>, ale url jest obowiązkowy.
Właściwości
| abort |
Służy do przerwania żądania później. |
| body | Zawartość treści HTTP (jeśli istnieje) |
| form |
Aby zasymulować wpis w formularzu przeglądarki |
| headers | Nagłówki HTTP do użycia podczas tworzenia żądania. |
| keep |
Jeśli połączenie powinno zostać ponownie użyte. Domyślnie ustawione na true. |
| method | Metoda HTTP, która ma być używana podczas wykonywania żądania. |
| on |
Wywołanie zwrotne uruchamiane po postępie pobierania. |
| on |
Wywołanie zwrotne uruchamiane po postępie przekazywania. |
| proxy |
Konfiguracja serwera proxy. |
| request |
Unikalny identyfikator żądania. Służy do rejestrowania i śledzenia. |
| span |
Opcje używane do tworzenia zakresu po włączeniu śledzenia. |
| stream |
Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse powinna być traktowana jako strumień. |
| timeout | Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem.
Jeśli żądanie zostanie zakończone, zostanie zgłoszony |
| url | Adres URL, do którego ma być skierowane żądanie. |
| with |
Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR. Wartość domyślna to fałsz. |
Szczegóły właściwości
abortSignal
Służy do przerwania żądania później.
abortSignal?: AbortSignalLike
Wartość właściwości
body
formData
Aby zasymulować wpis w formularzu przeglądarki
formData?: FormDataMap
Wartość właściwości
headers
Nagłówki HTTP do użycia podczas tworzenia żądania.
headers?: HttpHeaders
Wartość właściwości
keepAlive
Jeśli połączenie powinno zostać ponownie użyte. Domyślnie ustawione na true.
keepAlive?: boolean
Wartość właściwości
boolean
method
Metoda HTTP, która ma być używana podczas wykonywania żądania.
method?: HttpMethods
Wartość właściwości
onDownloadProgress
Wywołanie zwrotne uruchamiane po postępie pobierania.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Wartość właściwości
(progress: TransferProgressEvent) => void
onUploadProgress
Wywołanie zwrotne uruchamiane po postępie przekazywania.
onUploadProgress?: (progress: TransferProgressEvent) => void
Wartość właściwości
(progress: TransferProgressEvent) => void
proxySettings
requestId
Unikalny identyfikator żądania. Służy do rejestrowania i śledzenia.
requestId?: string
Wartość właściwości
string
spanOptions
Opcje używane do tworzenia zakresu po włączeniu śledzenia.
spanOptions?: SpanOptions
Wartość właściwości
streamResponseStatusCodes
Lista kodów stanu odpowiedzi, których odpowiednia treść PipelineResponse powinna być traktowana 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?: number
Wartość właściwości
number
url
Adres URL, do którego ma być skierowane żądanie.
url: string
Wartość właściwości
string
withCredentials
Jeśli poświadczenia (pliki cookie) powinny być wysyłane podczas XHR. Wartość domyślna to fałsz.
withCredentials?: boolean
Wartość właściwości
boolean