request

A function to retrieve headers sent from the server.

A function for retrieving all headers sent from the server.

The status code of the http response.

The error message code.

Additional error message(s).

The raw error object if the server returned a JSON error, or the response text otherwise.

The options used in the http request.

Indicates if the request required https.

The error message subcode.

The URL of the request that returned an error message.

Indicates if and how requests to ArcGIS Services are authenticated. Only applicable when esriConfig.request.useIdentity = true.

If uploading a file, specify the form data or element used to submit the file here. If specified, the parameters of the query will be added to the URL.

If true, the browser will send a request to the server instead of using the browser's local cache. If false, the browser's default cache handling will be used.

Headers to use for the request. This is an object whose property names are header names.

Indicates whether the browser will keep the associated request alive if the page that initiated it is unloaded before the request is complete, such as during page navigation or closing. See also keepalive for more details.

Indicates if the request should be made using the HTTP DELETE, HEAD, POST, or PUT method. By default, HTTP POST will be used for auto if the request size is longer than the maxUrlLength property set in config.request.

Query parameters for the request. The query parameters will be added to the URL if a GET request is used, or if the body property is set. If the body property is not set, the query parameters will be added to the request body when a DELETE, POST, or PUT request is used.

Response format. For details on the specific types, see: json, text, array-buffer, blob, image, native, native-request-init, document, and xml

AbortSignal allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Example:

const controller = new AbortController();
const signal = controller.signal;

esriRequest(url, { signal })
  .then((response) => {
    // The request went OK
  })
  .catch((err) => {
    if (err.name === 'AbortError') {
      console.log('Request aborted');
    } else {
      console.error('Error encountered', err);
    }
  });

// Abort requests that are aware of the controller's signal
controller.abort();

Indicates the amount of time in milliseconds to wait for a response from the server. Set to 0 to wait for the response indefinitely.

Indicates the request should use the proxy. By default, this is determined automatically based on the domain of the request URL.

Indicates if cross-site Access-Control requests should use credentials. It is also possible to push the domain to the config trustedServers if an application requires credentials. For additional information on withCredentials, please refer to this documentation.

The requested data. This value should match the RequestOptions responseType with the data return type. Possible types are: json, text, array-buffer, blob, image, native, native-request-init, document, and xml.

Method for getting a header sent from the server.

Method for getting all headers sent from the server.

Since 4.26 The status code of the http response.

The options specified by the user in the data request. See RequestOptions for available properties.

Indicates if the request required https.

The URL used to request the data.