ArcGIS REST JS

ArcGIS REST API JavaScript Client

ArcGISAuthError

Class

Extends

ArcGISRequestError

Constructors

new ArcGISAuthError(message: string, code: string | number, response: any, url: string, options: IRequestOptions) : ArcGISAuthError

Constructor Parameters

Parameter	Type	Default	Notes
message Optional	string	"AUTHENTICATION_ERROR"	The error message from the API
code Optional	string \| number	"AUTHENTICATION_ERROR_CODE"	The error code from the API
response Optional	any		The original response from the API that caused the error
url Optional	string		The original url of the request
options Optional	IRequestOptions		The original options of the request

Properties

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

Methods

Method	Returns	Notes
retry(getSession: IRetryAuthError, retryLimit: number)	Promise<Object>

retry

Class Method

retry(getSession: IRetryAuthError, retryLimit: number) : Promise<Object>

Parameters

Parameter	Type	Default	Notes
getSession Required	IRetryAuthError
retryLimit Optional	number	3

Returns

Promise<Object>

Class defined in packages/arcgis-rest-request/src/request.ts:49