WebResource interface

Paket:

@azure/storage-blob

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.
agent	HANYA NODEJS Opsi khusus simpul untuk menyediakan http.Agent/https.Agentkustom . CATATAN: biasanya ini harus menjadi satu instans yang dibagikan oleh beberapa permintaan sehingga koneksi yang mendasar ke layanan dapat digunakan kembali. Tidak melakukan apa pun saat berjalan di browser.
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.
proxySettings	Konfigurasi proxy.
query	String kueri yang direpresentasikan sebagai objek.
requestId	Pengidentifikasi unik untuk permintaan tersebut. Digunakan untuk pengelogan dan pelacakan.
requestOverrides	Opsi tambahan untuk diatur pada permintaan. Ini menyediakan cara untuk mengganti yang sudah ada atau memberikan properti permintaan yang tidak dideklarasikan. Untuk kemungkinan properti yang valid, lihat Opsi NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback Browser RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit PERINGATAN: Opsi yang ditentukan di sini akan menggantikan properti apa pun dengan nama yang sama saat permintaan dikirim oleh <xref:HttpClient>.
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.
url	URL yang diakses oleh permintaan.
withCredentials	Jika kredensial (cookie) harus dikirim bersama selama XHR.

Metode

clone()	Kloning objek permintaan ini.
prepare(unknown)	Ini adalah no-op untuk tujuan kompat dan akan melempar jika dipanggil.
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. Catatan: ini no-op untuk tujuan kompatiati.

Detail Properti

abortSignal

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

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

agent

HANYA NODEJS

Opsi khusus simpul untuk menyediakan http.Agent/https.Agentkustom . CATATAN: biasanya ini harus menjadi satu instans yang dibagikan oleh beberapa permintaan sehingga koneksi yang mendasar ke layanan dapat digunakan kembali. Tidak melakukan apa pun saat berjalan di browser.

agent?: Agent

Nilai Properti

Agent

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

HttpHeaders

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

proxySettings

Konfigurasi proxy.

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

requestOverrides

Opsi tambahan untuk diatur pada permintaan. Ini menyediakan cara untuk mengganti yang sudah ada atau memberikan properti permintaan yang tidak dideklarasikan.

Untuk kemungkinan properti yang valid, lihat

• Opsi NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback
• Browser RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

PERINGATAN: Opsi yang ditentukan di sini akan menggantikan properti apa pun dengan nama yang sama saat permintaan dikirim oleh <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

Nilai Properti

Record<string, unknown>

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

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

WebResource

prepare(unknown)

Ini adalah no-op untuk tujuan kompat dan akan melempar jika dipanggil.

function prepare(options: unknown): WebResourceLike

Parameter

options

unknown

Mengembalikan

WebResource

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. Catatan: ini no-op untuk tujuan kompatiati.

function validateRequestProperties()