AjaxRequest

interface stable

The object containing values RxJS used to make the HTTP request.

interface AjaxRequest {
  url: string
  body?: any
  method: string
  async: boolean
  headers: Readonly<Record<string, any>>
  timeout: number
  user?: string
  password?: string
  crossDomain: boolean
  withCredentials: boolean
  responseType: XMLHttpRequestResponseType
}

Description

This is provided in AjaxError instances as the request object.

Properties

Property Type Description
url string

The URL requested.

body any

The body to send over the HTTP request.

method string

The HTTP method used to make the HTTP request.

async boolean

Whether or not the request was made asynchronously.

headers Readonly<Record<string, any>>

The headers sent over the HTTP request.

timeout number

The timeout value used for the HTTP request. Note: this is only honored if the request is asynchronous (async is true).

user string

The user credentials user name sent with the HTTP request.

password string

The user credentials password sent with the HTTP request.

crossDomain boolean

Whether or not the request was a CORS request.

withCredentials boolean

Whether or not a CORS request was sent with credentials. If false, will also ignore cookies in the CORS response.

responseType XMLHttpRequestResponseType

The responseType set before sending the request.

© 2015–2021 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.
Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
https://rxjs.dev/api/ajax/AjaxRequest