WebResource class
Tworzy nowy obiekt WebResource.
Ta klasa zapewnia abstrakcję wywołania REST przez bycie biblioteką/implementacją niezależną od implementacji i opakowywanie niezbędnych właściwości do zainicjowania żądania.
Konstruktory
Właściwości
| abort |
|
| agent |
|
| body | |
| form |
|
| headers | |
| keep |
|
| method | |
| on |
Wywołanie zwrotne, które jest uruchamiane po postępie pobierania. |
| on |
Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania. |
| operation |
Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyty prosty odnośnik kodu stanu. |
| operation |
|
| proxy |
|
| query | |
| redirect |
|
| should |
Niezależnie od tego, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno być deserializowane. |
| stream |
Niezależnie od tego, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień. |
| timeout | |
| url | |
| with |
Metody
| clone() | Sklonuj ten obiekt żądania HTTP webResource. |
| prepare(Request |
Przygotowuje żądanie. |
| validate |
Sprawdza, czy wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"] są zdefiniowane. Spowoduje to wystąpienie błędu, jeśli jedna z powyższych właściwości nie jest zdefiniowana. |
Szczegóły konstruktora
WebResource(string, HttpMethods, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number)
new WebResource(url?: string, method?: HttpMethods, body?: any, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, agentSettings?: AgentSettings, redirectLimit?: number)Parametry
- url
-
string
- method
- HttpMethods
- body
-
any
- query
-
{[key: string]: any}
- headers
-
{[key: string]: any} | HttpHeadersLike
- streamResponseBody
-
boolean
- withCredentials
-
boolean
- abortSignal
- AbortSignalLike
- timeout
-
number
- onUploadProgress
-
(progress: TransferProgressEvent) => void
- onDownloadProgress
-
(progress: TransferProgressEvent) => void
- proxySettings
- ProxySettings
- keepAlive
-
boolean
- agentSettings
- AgentSettings
- redirectLimit
-
number
Szczegóły właściwości
abortSignal
agentSettings
body
body?: anyWartość właściwości
any
formData
formData?: anyWartość właściwości
any
headers
keepAlive
keepAlive?: booleanWartość właściwości
boolean
method
onDownloadProgress
Wywołanie zwrotne, które jest uruchamiane po postępie pobierania.
onDownloadProgress?: (progress: TransferProgressEvent) => voidWartość właściwości
(progress: TransferProgressEvent) => void
onUploadProgress
Wywołanie zwrotne, które jest uruchamiane po postępie przekazywania.
onUploadProgress?: (progress: TransferProgressEvent) => voidWartość właściwości
(progress: TransferProgressEvent) => void
operationResponseGetter
Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyty prosty odnośnik kodu stanu.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseWartość właściwości
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
query?: {[key: string]: any}Wartość właściwości
{[key: string]: any}
redirectLimit
redirectLimit?: numberWartość właściwości
number
shouldDeserialize
Niezależnie od tego, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno być deserializowane.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanWartość właściwości
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Niezależnie od tego, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień.
streamResponseBody?: booleanWartość właściwości
boolean
timeout
timeout: numberWartość właściwości
number
url
url: stringWartość właściwości
string
withCredentials
withCredentials: booleanWartość właściwości
boolean
Szczegóły metody
clone()
Sklonuj ten obiekt żądania HTTP webResource.
function clone(): WebResourceZwraca
Klon tego obiektu żądania HTTP webResource.
prepare(RequestPrepareOptions)
Przygotowuje żądanie.
function prepare(options: RequestPrepareOptions): WebResourceParametry
- options
- RequestPrepareOptions
Opcje do przygotowania żądania.
Zwraca
Zwraca przygotowany obiekt WebResource (żądanie HTTP), który musi zostać przekazany potokowi żądań.
validateRequestProperties()
Sprawdza, czy wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"] są zdefiniowane. Spowoduje to wystąpienie błędu, jeśli jedna z powyższych właściwości nie jest zdefiniowana.
function validateRequestProperties()