dojo/request/xhr.__BaseOptions (version 1.10)

Note: This is not a real constructor, but just a description of the type of object that should be passed as a parameter to some method(s), and/or the return value from some method(s). In other words, the type exists only for documentation purposes, and you cannot call new xhr.__BaseOptions()

See the dojo/request/xhr.__BaseOptions reference documentation for more information.

Property Summary

  • dataData to transfer.
  • handleAsHow to handle the response from the server.
  • headersHeaders to use for the request.
  • passwordPassword to use during the request.
  • preventCacheWhether to append a cache-busting parameter to the URL.
  • queryQuery parameters to append to the URL.
  • syncWhether to make a synchronous request or not.
  • timeoutMilliseconds to wait for the response.
  • userUsername to use during the request.
  • withCredentialsFor cross-site requests, whether to send credentials or not.

Properties

data
Defined by: dojo/request/xhr

Data to transfer. This is ignored for GET and DELETE requests.

handleAs
Defined by: dojo/request

How to handle the response from the server. Default is 'text'. Other values are 'json', 'javascript', and 'xml'.

headers
Defined by: dojo/request/xhr

Headers to use for the request.

password
Defined by: dojo/request/xhr

Password to use during the request.

preventCache
Defined by: dojo/request

Whether to append a cache-busting parameter to the URL.

query
Defined by: dojo/request

Query parameters to append to the URL.

sync
Defined by: dojo/request/xhr

Whether to make a synchronous request or not. Default is false (asynchronous).

timeout
Defined by: dojo/request

Milliseconds to wait for the response. If this time passes, the then the promise is rejected.

user
Defined by: dojo/request/xhr

Username to use during the request.

withCredentials
Defined by: dojo/request/xhr

For cross-site requests, whether to send credentials or not.

Error in the documentation? Can’t find what you are looking for? Let us know!