ArcGISRequestError | ArcGIS REST JS

Class

This represents a generic error from an ArcGIS endpoint. There will be details about the error in the ArcGISRequestError.message , ArcGISRequestError.originalMessage properties on the error. You can also access the original server response at ArcGISRequestError.response which may have additional details.

Use dark colors for code blocksCopy
request(someUrl, someOptions).catch(e => {
 if(e.name === "ArcGISRequestError") {
   console.log("Something went wrong with the request:", e);
   console.log("Full server response", e.response);
 }
})

Inheritance: ArcGISRequestErrorError

Subclasses: ArcGISAuthError

Constructors

constructor

Class Constructor

ArcGISRequestError(message?: string, code?: string | number, response?: any, url?: string, options?: IRequestOptions): ArcGISRequestError

Create a new ArcGISRequestError object.

Parameters

Parameter	Type	Notes
`message`	string	The error message from the API
`code`	string \| number	The error code from the API
`response`	any	The original response from the API that caused the error
`url`	string	The original url of the request
`options`	IRequestOptions	The original options and parameters of the request

Returns

ArcGISRequestError

Properties

Property	Type	Notes
`code`	`string \| number`	The error code returned from the request.
`message`	`string`	Formatted error message. See the `Error` class for more details.
`name`	`string`	The name of this error. Will always be `"ArcGISRequestError"` to conform with the `Error` class.
`options`	`IRequestOptions`	The options of the original request that caused the error
`originalMessage`	`string`	The errror message return from the request.
`response`	`any`	The original JSON response the caused the error.
`url`	`string`	The URL of the original request that caused the error

code

Class Property

code: string | number

The error code returned from the request.

message

Class Property

message: string

Formatted error message. See the Error class for more details.

name

Class Property

name: string

The name of this error. Will always be "ArcGISRequestError" to conform with the Error class.

options

Class Property

options: IRequestOptions

The options of the original request that caused the error

originalMessage

Class Property

originalMessage: string

The errror message return from the request.

response

Class Property

response: any

The original JSON response the caused the error.

url

Class Property

url: string

The URL of the original request that caused the error