WebResourceLike interface

Paquete:

@azure/ms-rest-js

Abstracción a través de una llamada REST.

Propiedades

abortSignal	Se usa para anular la solicitud más adelante.
agentSettings	Configuración del agente HTTP(S).
body	Contenido del cuerpo HTTP de la solicitud.
formData
headers	Encabezados HTTP que se usarán al realizar la solicitud.
keepAlive	Si se debe reutilizar la conexión.
method	Método HTTP que se va a usar al realizar la solicitud.
onDownloadProgress	Devolución de llamada que se desencadena tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se desencadena tras el progreso de la carga.
operationResponseGetter	Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si esto no está definido, se usará una búsqueda de código de estado simple.
operationSpec	Se usa para analizar la respuesta.
proxySettings	Configuración de proxy.
query	Cadena de consulta representada como un objeto .
redirectLimit	Limite el número de redireccionamientos seguidos para esta solicitud. Si se establece en 0, no se seguirán las redirecciones. Si se deja sin definir, se aplicará el comportamiento de redireccionamiento predeterminado del node_fetch subyacente.
shouldDeserialize	Si se debe deserializar o no HttpOperationResponse. Si esto no está definido, se debe deserializar HttpOperationResponse.
streamResponseBody	Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
timeout	El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .
url	Dirección URL a la que accede la solicitud.
withCredentials	Si las credenciales (cookies) deben enviarse durante una XHR.

Métodos

clone()	Clone este objeto de solicitud.
prepare(RequestPrepareOptions)	Establece las opciones de la solicitud.
validateRequestProperties()	Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente.

Detalles de las propiedades

abortSignal

Se usa para anular la solicitud más adelante.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

agentSettings

Configuración del agente HTTP(S).

agentSettings?: AgentSettings

Valor de propiedad

AgentSettings

body

Contenido del cuerpo HTTP de la solicitud.

body?: any

Valor de propiedad

any

formData

formData?: any

Valor de propiedad

any

headers

Encabezados HTTP que se usarán al realizar la solicitud.

headers: HttpHeadersLike

Valor de propiedad

HttpHeadersLike

keepAlive

Si se debe reutilizar la conexión.

keepAlive?: boolean

Valor de propiedad

boolean

method

Método HTTP que se va a usar al realizar la solicitud.

method: HttpMethods

Valor de propiedad

HttpMethods

onDownloadProgress

Devolución de llamada que se desencadena tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

onUploadProgress

Devolución de llamada que se desencadena tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

operationResponseGetter

Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si esto no está definido, se usará una búsqueda de código de estado simple.

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

Valor de propiedad

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

operationSpec

Se usa para analizar la respuesta.

operationSpec?: OperationSpec

Valor de propiedad

OperationSpec

proxySettings

Configuración de proxy.

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

query

Cadena de consulta representada como un objeto .

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

Valor de propiedad

{[key: string]: any}

redirectLimit

Limite el número de redireccionamientos seguidos para esta solicitud. Si se establece en 0, no se seguirán las redirecciones. Si se deja sin definir, se aplicará el comportamiento de redireccionamiento predeterminado del node_fetch subyacente.

redirectLimit?: number

Valor de propiedad

number

shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si esto no está definido, se debe deserializar HttpOperationResponse.

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

Valor de propiedad

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.

streamResponseBody?: boolean

Valor de propiedad

boolean

timeout

El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .

timeout: number

Valor de propiedad

number

url

Dirección URL a la que accede la solicitud.

url: string

Valor de propiedad

string

withCredentials

Si las credenciales (cookies) deben enviarse durante una XHR.

withCredentials: boolean

Valor de propiedad

boolean

Detalles del método

clone()

Clone este objeto de solicitud.

function clone(): WebResourceLike

Devoluciones

WebResourceLike

prepare(RequestPrepareOptions)

Establece las opciones de la solicitud.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parámetros

options

RequestPrepareOptions

Devoluciones

WebResourceLike

validateRequestProperties()

Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente.

function validateRequestProperties()