Aracılığıyla paylaş


WebResource interface

Uzak sunucuya yapılacak HTTP isteğinin açıklaması.

Özellikler

abortSignal

İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.

agent

YALNıZCA NODEJS

Özel bir http.Agent/https.Agentsağlamak için yalnızca düğüm seçeneği. NOT: Hizmetle temel alınan bağlantının yeniden kullanılabilmesi için bu genellikle birden çok istek tarafından paylaşılan bir örnek olmalıdır. Tarayıcıda çalışırken hiçbir şey yapmaz.

body

İsteğin HTTP gövde içeriği.

decompressResponse

yanıtın Accept-Encoding üst bilgisine göre açılıp açılmayacağı (yalnızca düğüm getirme)

formData

İstek gövdesini oluşturmak için kullanılan form verileri.

headers

İstek yapılırken kullanılacak HTTP üst bilgileri.

keepAlive

Bağlantının yeniden kullanılması gerekiyorsa.

method

İstek yapılırken kullanılacak HTTP yöntemi.

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri arama.

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.

proxySettings

Proxy yapılandırması.

query

Nesne olarak temsil edilen sorgu dizesi.

requestId

İstek için benzersiz bir tanımlayıcı. Günlüğe kaydetme ve izleme için kullanılır.

requestOverrides

İstekte ayarlanacak ek seçenekler. Bu, var olanları geçersiz kılmak veya bildirilmemiş istek özelliklerini sağlamak için bir yol sağlar.

Olası geçerli özellikler için bkz.

UYARI: Burada belirtilen seçenekler, tarafından istek gönderildiğinde <xref:HttpClient>aynı adların tüm özelliklerini geçersiz kılar.

streamResponseBody

HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.

streamResponseStatusCodes

Karşılık gelen HttpOperationResponse gövdesi bir akış olarak ele alınması gereken yanıt durum kodlarının listesi.

timeout

otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.

url

İstek tarafından erişilen URL.

withCredentials

Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa.

Yöntemler

clone()

Bu istek nesnesini klonla.

prepare(unknown)

Bu, uyumluluk amacıyla bir no-op ve çağrılırsa atılacaktır.

validateRequestProperties()

yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmadıysa hata oluşturur. Not: Bu, uyumluluk amacıyla bir no-op.

Özellik Ayrıntıları

abortSignal

İptal denetleyicisi sinyali. Hem ağ isteği göndermeyi hem de yanıt beklemeyi durdurmak için kullanılabilir.

abortSignal?: AbortSignalLike

Özellik Değeri

agent

YALNıZCA NODEJS

Özel bir http.Agent/https.Agentsağlamak için yalnızca düğüm seçeneği. NOT: Hizmetle temel alınan bağlantının yeniden kullanılabilmesi için bu genellikle birden çok istek tarafından paylaşılan bir örnek olmalıdır. Tarayıcıda çalışırken hiçbir şey yapmaz.

agent?: Agent

Özellik Değeri

body

İsteğin HTTP gövde içeriği.

body?: any

Özellik Değeri

any

decompressResponse

yanıtın Accept-Encoding üst bilgisine göre açılıp açılmayacağı (yalnızca düğüm getirme)

decompressResponse?: boolean

Özellik Değeri

boolean

formData

İstek gövdesini oluşturmak için kullanılan form verileri.

formData?: any

Özellik Değeri

any

headers

İstek yapılırken kullanılacak HTTP üst bilgileri.

headers: HttpHeadersLike

Özellik Değeri

keepAlive

Bağlantının yeniden kullanılması gerekiyorsa.

keepAlive?: boolean

Özellik Değeri

boolean

method

İstek yapılırken kullanılacak HTTP yöntemi.

method: HttpMethods

Özellik Değeri

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri arama.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri arama.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

proxySettings

Proxy yapılandırması.

proxySettings?: ProxySettings

Özellik Değeri

query

Nesne olarak temsil edilen sorgu dizesi.

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

Özellik Değeri

{[key: string]: any}

requestId

İstek için benzersiz bir tanımlayıcı. Günlüğe kaydetme ve izleme için kullanılır.

requestId: string

Özellik Değeri

string

requestOverrides

İstekte ayarlanacak ek seçenekler. Bu, var olanları geçersiz kılmak veya bildirilmemiş istek özelliklerini sağlamak için bir yol sağlar.

Olası geçerli özellikler için bkz.

UYARI: Burada belirtilen seçenekler, tarafından istek gönderildiğinde <xref:HttpClient>aynı adların tüm özelliklerini geçersiz kılar.

requestOverrides?: Record<string, unknown>

Özellik Değeri

Record<string, unknown>

streamResponseBody

Uyarı

Bu API artık kullanım dışıdır.

Use streamResponseStatusCodes property instead.

HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.

streamResponseBody?: boolean

Özellik Değeri

boolean

streamResponseStatusCodes

Karşılık gelen HttpOperationResponse gövdesi bir akış olarak ele alınması gereken yanıt durum kodlarının listesi.

streamResponseStatusCodes?: Set<number>

Özellik Değeri

Set<number>

timeout

otomatik olarak sonlandırılmadan önce bir isteğin alabildiği milisaniye sayısı. İstek sonlandırılırsa bir AbortError oluşturulur.

timeout: number

Özellik Değeri

number

url

İstek tarafından erişilen URL.

url: string

Özellik Değeri

string

withCredentials

Kimlik bilgilerinin (tanımlama bilgileri) bir XHR sırasında birlikte gönderilmesi gerekiyorsa.

withCredentials: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

clone()

Bu istek nesnesini klonla.

function clone(): WebResourceLike

Döndürülenler

prepare(unknown)

Bu, uyumluluk amacıyla bir no-op ve çağrılırsa atılacaktır.

function prepare(options: unknown): WebResourceLike

Parametreler

options

unknown

Döndürülenler

validateRequestProperties()

yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmadıysa hata oluşturur. Not: Bu, uyumluluk amacıyla bir no-op.

function validateRequestProperties()