WebResourceLike interface

Paket:

@azure/core-http

Deskripsi permintaan HTTP yang akan dibuat ke server jarak jauh.

Properti

abortSignal	Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.
body	Isi HTTP isi permintaan.
decompressResponse	Apakah akan mendekompresi respons sesuai dengan header Accept-Encoding (hanya pengambilan node)
formData	Data formulir, digunakan untuk membangun isi permintaan.
headers	Header HTTP yang akan 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 yang direpresentasikan sebagai objek.
requestId	Pengidentifikasi unik untuk permintaan tersebut. Digunakan untuk pengelogan dan pelacakan.
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.
streamResponseStatusCodes	Daftar kode status respons yang isi HttpOperationResponse terkait harus diperlakukan sebagai aliran.
timeout	Jumlah milidetik yang dapat diambil permintaan sebelum dihentikan secara otomatis. Jika permintaan dihentikan, AbortError akan dilemparkan.
tracingContext	Pelacakan: Konteks yang digunakan saat membuat rentang.
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

Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

body

Isi HTTP isi permintaan.

body?: any

Nilai Properti

any

decompressResponse

Apakah akan mendekompresi respons sesuai dengan header Accept-Encoding (hanya pengambilan node)

decompressResponse?: boolean

Nilai Properti

boolean

formData

Data formulir, digunakan untuk membangun isi permintaan.

formData?: any

Nilai Properti

any

headers

Header HTTP yang akan 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 yang direpresentasikan sebagai objek.

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

Nilai Properti

{[key: string]: any}

requestId

Pengidentifikasi unik untuk permintaan tersebut. Digunakan untuk pengelogan dan pelacakan.

requestId: string

Nilai Properti

string

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

Peringatan

API ini sudah tidak digunakan lagi.

Use streamResponseStatusCodes property instead.

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.

streamResponseBody?: boolean

Nilai Properti

boolean

streamResponseStatusCodes

Daftar kode status respons yang isi HttpOperationResponse terkait harus diperlakukan sebagai aliran.

streamResponseStatusCodes?: Set<number>

Nilai Properti

Set<number>

timeout

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

timeout: number

Nilai Properti

number

tracingContext

Pelacakan: Konteks yang digunakan saat membuat rentang.

tracingContext?: Context

Nilai Properti

@azure/core-tracing.Context

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