WebResource interface
Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.
Propiedades
abort |
Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y esperar una respuesta. |
body | Contenido del cuerpo HTTP de la solicitud. |
decompress |
Si se va a descomprimir o no la respuesta según Accept-Encoding encabezado (solo captura de nodo) |
form |
Datos del formulario, que se usan para compilar el cuerpo de la solicitud. |
headers | Encabezados HTTP que se usarán al realizar la solicitud. |
keep |
Si se debe reutilizar la conexión. |
method | Método HTTP que se va a usar al realizar la solicitud. |
on |
Devolución de llamada que se desencadena tras el progreso de la descarga. |
on |
Devolución de llamada que se desencadena tras el progreso de la carga. |
proxy |
Configuración de proxy. |
query | Cadena de consulta representada como un objeto . |
request |
Identificador único de la solicitud. Se usa para el registro y el seguimiento. |
stream |
Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia. |
stream |
Lista de códigos de estado de respuesta cuyo cuerpo HttpOperationResponse correspondiente 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 |
url | Dirección URL a la que accede la solicitud. |
with |
Si las credenciales (cookies) deben enviarse durante una XHR. |
Métodos
clone() | Clone este objeto de solicitud. |
prepare(unknown) | Se trata de una operación sin operación con fines de compatibilidad y se producirá si se llama a . |
validate |
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. Nota: esta operación no está operativa con fines de compatibilidad. |
Detalles de las propiedades
abortSignal
Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y esperar una respuesta.
abortSignal?: AbortSignalLike
Valor de propiedad
body
Contenido del cuerpo HTTP de la solicitud.
body?: any
Valor de propiedad
any
decompressResponse
Si se va a descomprimir o no la respuesta según Accept-Encoding encabezado (solo captura de nodo)
decompressResponse?: boolean
Valor de propiedad
boolean
formData
Datos del formulario, que se usan para compilar el cuerpo de la solicitud.
formData?: any
Valor de propiedad
any
headers
Encabezados HTTP que se usarán al realizar la solicitud.
headers: HttpHeadersLike
Valor de propiedad
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
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
proxySettings
query
Cadena de consulta representada como un objeto .
query?: {[key: string]: any}
Valor de propiedad
{[key: string]: any}
requestId
Identificador único de la solicitud. Se usa para el registro y el seguimiento.
requestId: string
Valor de propiedad
string
streamResponseBody
Advertencia
Esta API ya está en desuso.
Use streamResponseStatusCodes property instead.
Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
streamResponseBody?: boolean
Valor de propiedad
boolean
streamResponseStatusCodes
Lista de códigos de estado de respuesta cuyo cuerpo HttpOperationResponse correspondiente debe tratarse como una secuencia.
streamResponseStatusCodes?: Set<number>
Valor de propiedad
Set<number>
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()
prepare(unknown)
Se trata de una operación sin operación con fines de compatibilidad y se producirá si se llama a .
function prepare(options: unknown): WebResourceLike
Parámetros
- options
-
unknown
Devoluciones
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. Nota: esta operación no está operativa con fines de compatibilidad.
function validateRequestProperties()