dojo/request.__Options (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 request.__Options()

Property Summary

  • dataData to transfer.
  • handleAsHow to handle the response from the server.
  • methodThe HTTP method to use to make the request.
  • preventCacheWhether to append a cache-busting parameter to the URL.
  • queryQuery parameters to append to the URL.
  • timeoutMilliseconds to wait for the response.

Properties

data
Defined by: dojo/request

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'.

method
Defined by: dojo/request

The HTTP method to use to make the request. Must be uppercase.

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.

timeout
Defined by: dojo/request

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

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