Error | References | ArcGIS Maps SDK for JavaScript

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

const Error = await $arcgis.import("@arcgis/core/core/Error.js");

Subclasses: VolumeMeasurementError, ElevationProfileError

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

request

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

Constructor

Parameters

Parameter	Type	Description
name	string	A unique error name.
message	string	A message describing the details of the error.
details	T	The details object provides additional details specific to the error.

Properties

Property	Type	Class
details	T \| null \| undefined
message readonly	string
name readonly	string

details

Property

Type: T | null | undefined

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

readonly Property

Type: string

Message describing the error.

Example

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

name

readonly Property

Type: 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);
});