WebResourceLike interface

Paket:

@azure/ms-rest-js

REST çağrısı üzerinden soyutlama.

Özellikler

abortSignal	İsteği daha sonra durdurmak için kullanılır.
agentSettings	HTTP(S) aracı yapılandırması.
body	İsteğin HTTP gövde içeriği.
formData
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 çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
operationResponseGetter	Verilen OperationSpec ve HttpOperationResponse bileşimi için uygun OperationResponse değerini döndüren bir işlev. Bu tanımlanmamışsa, basit bir durum kodu araması kullanılır.
operationSpec	Yanıtı ayrıştırmak için kullanılır.
proxySettings	Ara sunucu yapılandırması.
query	Nesne olarak temsil edilen sorgu dizesi.
redirectLimit	Bu istek için izlenen yeniden yönlendirme sayısını sınırlayın. 0 olarak ayarlanırsa, yeniden yönlendirmeler izlenmez. Tanımsız bırakılırsa, temel node_fetch varsayılan yeniden yönlendirme davranışı uygulanır.
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
streamResponseBody	HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.
timeout	bir isteğin otomatik olarak sonlandırılmadan önce 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(RequestPrepareOptions)	İstekte seçenekleri ayarlar.
validateRequestProperties()	yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmamışsa hata oluşturur.

Özellik Ayrıntıları

abortSignal

İsteği daha sonra durdurmak için kullanılır.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

agentSettings

HTTP(S) aracı yapılandırması.

agentSettings?: AgentSettings

Özellik Değeri

AgentSettings

body

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

body?: any

Özellik Değeri

any

formData

formData?: any

Özellik Değeri

any

headers

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

headers: HttpHeadersLike

Özellik Değeri

HttpHeadersLike

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

HttpMethods

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri çağırma.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

operationResponseGetter

Verilen OperationSpec ve HttpOperationResponse bileşimi için uygun OperationResponse değerini döndüren bir işlev. Bu tanımlanmamışsa, basit bir durum kodu araması kullanılır.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Özellik Değeri

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Yanıtı ayrıştırmak için kullanılır.

operationSpec?: OperationSpec

Özellik Değeri

OperationSpec

proxySettings

Ara sunucu yapılandırması.

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

query

Nesne olarak temsil edilen sorgu dizesi.

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

Özellik Değeri

{[key: string]: any}

redirectLimit

Bu istek için izlenen yeniden yönlendirme sayısını sınırlayın. 0 olarak ayarlanırsa, yeniden yönlendirmeler izlenmez. Tanımsız bırakılırsa, temel node_fetch varsayılan yeniden yönlendirme davranışı uygulanır.

redirectLimit?: number

Özellik Değeri

number

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Özellik Değeri

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

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

streamResponseBody?: boolean

Özellik Değeri

boolean

timeout

bir isteğin otomatik olarak sonlandırılmadan önce 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

WebResourceLike

prepare(RequestPrepareOptions)

İstekte seçenekleri ayarlar.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parametreler

options

RequestPrepareOptions

Döndürülenler

WebResourceLike

validateRequestProperties()

yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmamışsa hata oluşturur.

function validateRequestProperties()