Error

Error

AMD: require(["esri/core/Error"], (Error) => { /* code goes here */ });

ESM: import Error from "@arcgis/core/core/Error.js";

Class: esri/core/Error

Since: ArcGIS Maps SDK for JavaScript 4.5

Error is a class that enhances the debugging and error handling process. Rather than returning a generic JavaScript error, this Error returns a standardized error object with several properties. The error class can be useful in many scenarios, such as working with promises, the esriRequest module, and many different layers and widgets.

See also

Example

button.on("click", function() {
  esriRequest(url, options).then(function(response) {
    // do something useful
  }).catch(function(error){
    console.log("informative error message: ", error.message);
  });
});

Constructors

new Error(name, message, details)

Parameters

name String

A unique error name.

message String

optional

A message describing the details of the error.

details Object

optional

The details object provides additional details specific to the error.

Property Overview

Type	Summary	Class
Object	The details object provides additional details specific to the error, giving more information about why the error was raised. more details	Error
String	A message describing the details of the error. more details	Error
String	A unique error name. more details	Error

Property Details

details Object

The details object provides additional details specific to the error, giving more information about why the error was raised. For example, the details object for esriRequest includes additional information to help the developer diagnose issues with a problematic request.

Example

someAsyncFunction.then(callback)
  .catch(function(error){
    console.log("Error details: ", error.details);
});

message String

A message describing the details of the error.

Example

someAsyncFunction.then(callback)
  .catch(function(error){
    console.log("Error message: ", error.message);
});

name String

A unique error name. This can be used to map to a localized error message to present to the user.

Example

someAsyncFunction.then(callback)
  .catch(function(error){
    console.log("Error name: ", error.name);
});

ArcGIS Maps SDK for JavaScriptAPI Reference

Was this page helpful?

Was this page helpful?