AjaxConfig

The address of the resource to request via HTTP.

The body of the HTTP request to send.

This is serialized, by default, based off of the value of the "content-type" header. For example, if the "content-type" is "application/json", the body will be serialized as JSON. If the "content-type" is "application/x-www-form-urlencoded", whatever object passed to the body will be serialized as URL, using key-value pairs based off of the keys and values of the object. In all other cases, the body will be passed directly.

Whether or not to send the request asynchronously. Defaults to true. If set to false, this will block the thread until the AJAX request responds.

The HTTP Method to use for the request. Defaults to "GET".

The HTTP headers to apply.

Note that, by default, RxJS will add the following headers under certain conditions:

1. If the "content-type" header is NOT set, and the body is FormData, a "content-type" of "application/x-www-form-urlencoded; charset=UTF-8" will be set automatically.
2. If the "x-requested-with" header is NOT set, and the crossDomain configuration property is NOT explicitly set to true, (meaning it is not a CORS request), a "x-requested-with" header with a value of "XMLHttpRequest" will be set automatically. This header is generally meaningless, and is set by libraries and frameworks using XMLHttpRequest to make HTTP requests.

The time to wait before causing the underlying XMLHttpRequest to timeout. This is only honored if the async configuration setting is unset or set to true. Defaults to 0, which is idiomatic for "never timeout".

The user credentials user name to send with the HTTP request

The user credentials password to send with the HTTP request

Whether or not to send the HTTP request as a CORS request. Defaults to false.

To send user credentials in a CORS request, set to true. To exclude user credentials from a CORS request, OR when cookies are to be ignored by the CORS response, set to false.

Defaults to false.

The name of your site's XSRF cookie.

The name of a custom header that you can use to send your XSRF cookie.

Can be set to change the response type. Valid values are "arraybuffer", "blob", "document", "json", and "text". Note that the type of "document" (such as an XML document) is ignored if the global context is not Window.

Defaults to "json".

An optional factory used to create the XMLHttpRequest object used to make the AJAX request. This is useful in environments that lack XMLHttpRequest, or in situations where you wish to override the default XMLHttpRequest for some reason.

If not provided, the XMLHttpRequest in global scope will be used.

NOTE: This AJAX implementation relies on the built-in serialization and setting of Content-Type headers that is provided by standards-compliant XMLHttpRequest implementations, be sure any implementation you use meets that standard.

An observer for watching the upload progress of an HTTP request. Will emit progress events, and completes on the final upload load event, will error for any XHR error or timeout.

This will not error for errored status codes. Rather, it will always complete when the HTTP response comes back.

If true, will emit all download progress and load complete events as AjaxResponse from the observable. The final download event will also be emitted as a AjaxResponse.

If both this and includeUploadProgress are false, then only the AjaxResponse will be emitted from the resulting observable.

If true, will emit all upload progress and load complete events as AjaxResponse from the observable. The final download event will also be emitted as a AjaxResponse.

If both this and includeDownloadProgress are false, then only the AjaxResponse will be emitted from the resulting observable.

Query string parameters to add to the URL in the request. This will require a polyfill for URL and URLSearchParams in Internet Explorer!

Accepts either a query string, a URLSearchParams object, a dictionary of key/value pairs, or an array of key/value entry tuples. (Essentially, it takes anything that new URLSearchParams would normally take).

If, for some reason you have a query string in the url argument, this will append to the query string in the url, but it will also overwrite the value of any keys that are an exact match. In other words, a url of /test?a=1&b=2, with queryParams of { b: 5, c: 6 } will result in a url of roughly /test?a=1&b=5&c=6.