WebResourceLike interface

  • Referensi
Paket:
@azure/ms-rest-js

Abstraksi melalui panggilan REST.

Properti

abortSignal

Digunakan untuk membatalkan permintaan nanti.
agentSettings

Konfigurasi agen HTTP(S).
body

Isi HTTP isi permintaan.
formData
headers

Header HTTP yang digunakan saat membuat permintaan.
keepAlive

Jika koneksi harus digunakan kembali.
method

Metode HTTP yang digunakan saat membuat permintaan.
onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
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.
operationSpec

Digunakan untuk mengurai respons.
proxySettings

Konfigurasi proksi.
query

String kueri direpresentasikan sebagai objek.
redirectLimit

Batasi jumlah pengalihan yang diikuti untuk permintaan ini. Jika diatur ke 0, pengalihan tidak akan diikuti. Jika dibiarkan tidak terdefinisi, perilaku pengalihan default dari node_fetch yang mendasar akan berlaku.
shouldDeserialize

Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.
streamResponseBody

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.
timeout

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, akan AbortError dilemparkan.
url

URL yang diakses oleh permintaan.
withCredentials

Jika kredensial (cookie) harus dikirim bersama selama XHR.

Metode

clone()

Kloning objek permintaan ini.
prepare(RequestPrepareOptions)

Mengatur opsi pada 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.

Detail Properti

abortSignal

Digunakan untuk membatalkan permintaan nanti.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

agentSettings

Konfigurasi agen HTTP(S).

agentSettings?: AgentSettings

Nilai Properti

AgentSettings

body

Isi HTTP isi permintaan.

body?: any

Nilai Properti

any

formData 

formData?: any

Nilai Properti

any

headers

Header HTTP yang digunakan saat membuat permintaan.

headers: HttpHeadersLike

Nilai Properti

HttpHeadersLike

keepAlive

Jika koneksi harus digunakan kembali.

keepAlive?: boolean

Nilai Properti

boolean

method

Metode HTTP yang digunakan saat membuat permintaan.

method: HttpMethods

Nilai Properti

HttpMethods

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

Digunakan untuk mengurai respons.

operationSpec?: OperationSpec

Nilai Properti

OperationSpec

proxySettings

Konfigurasi proksi.

proxySettings?: ProxySettings

Nilai Properti

ProxySettings

query

String kueri direpresentasikan sebagai objek.

query?: {[key: string]: any}

Nilai Properti

{[key: string]: any}

redirectLimit

Batasi jumlah pengalihan yang diikuti untuk permintaan ini. Jika diatur ke 0, pengalihan tidak akan diikuti. Jika dibiarkan tidak terdefinisi, perilaku pengalihan default dari node_fetch yang mendasar akan berlaku.

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

Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, akan AbortError dilemparkan.

timeout: number

Nilai Properti

number

url

URL yang diakses oleh permintaan.

url: string

Nilai Properti

string

withCredentials

Jika kredensial (cookie) harus dikirim bersama selama XHR.

withCredentials: boolean

Nilai Properti

boolean

Detail Metode

clone()

Kloning objek permintaan ini.

function clone(): WebResourceLike

Mengembalikan

WebResourceLike

prepare(RequestPrepareOptions)

Mengatur opsi pada permintaan.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameter

options
RequestPrepareOptions

Mengembalikan

WebResourceLike

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()