WebResource class
Membuat objek WebResource baru.
Kelas ini menyediakan abstraksi atas panggilan REST dengan menjadi pustaka/implementasi agnostik dan membungkus properti yang diperlukan untuk memulai permintaan.
Konstruktor
Properti
abort |
|
agent |
|
body | |
form |
|
headers | |
keep |
|
method | |
on |
Panggilan balik yang diaktifkan setelah kemajuan pengunduhan. |
on |
Panggilan balik yang diaktifkan setelah kemajuan pengunggahan. |
operation |
Fungsi yang mengembalikan OperationResponse yang tepat untuk kombinasi OperationSpec dan HttpOperationResponse yang diberikan. Jika ini tidak ditentukan, maka pencarian kode status sederhana akan digunakan. |
operation |
|
proxy |
|
query | |
redirect |
|
should |
Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi. |
stream |
Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak. |
timeout | |
url | |
with |
Metode
clone() | Kloning objek permintaan HTTP WebResource ini. |
prepare(Request |
Menyiapkan permintaan. |
validate |
Memvalidasi bahwa properti yang diperlukan seperti metode, url, header["Content-Type"], header["accept-language"] ditentukan. Ini akan melemparkan kesalahan jika salah satu properti yang disebutkan di atas tidak ditentukan. |
Detail Konstruktor
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)
Parameter
- 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
Detail Properti
abortSignal
agentSettings
body
body?: any
Nilai Properti
any
formData
formData?: any
Nilai Properti
any
headers
keepAlive
keepAlive?: boolean
Nilai Properti
boolean
method
onDownloadProgress
Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Nilai Properti
(progress: TransferProgressEvent) => void
onUploadProgress
Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
onUploadProgress?: (progress: TransferProgressEvent) => void
Nilai Properti
(progress: TransferProgressEvent) => void
operationResponseGetter
Fungsi yang mengembalikan OperationResponse yang tepat untuk kombinasi OperationSpec dan HttpOperationResponse yang diberikan. Jika ini tidak ditentukan, maka pencarian kode status sederhana akan digunakan.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
Nilai Properti
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
query?: {[key: string]: any}
Nilai Properti
{[key: string]: any}
redirectLimit
redirectLimit?: number
Nilai Properti
number
shouldDeserialize
Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
Nilai Properti
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.
streamResponseBody?: boolean
Nilai Properti
boolean
timeout
timeout: number
Nilai Properti
number
url
url: string
Nilai Properti
string
withCredentials
withCredentials: boolean
Nilai Properti
boolean
Detail Metode
clone()
Kloning objek permintaan HTTP WebResource ini.
function clone(): WebResource
Mengembalikan
Kloning objek permintaan HTTP WebResource ini.
prepare(RequestPrepareOptions)
Menyiapkan permintaan.
function prepare(options: RequestPrepareOptions): WebResource
Parameter
- options
- RequestPrepareOptions
Opsi yang disediakan untuk menyiapkan permintaan.
Mengembalikan
Mengembalikan objek WebResource (Permintaan HTTP) yang disiapkan yang perlu diberikan ke alur permintaan.
validateRequestProperties()
Memvalidasi bahwa properti yang diperlukan seperti metode, url, header["Content-Type"], header["accept-language"] ditentukan. Ini akan melemparkan kesalahan jika salah satu properti yang disebutkan di atas tidak ditentukan.
function validateRequestProperties()