Class ArcGISAuthError

Hierarchy

  • ArcGISRequestError
    • ArcGISAuthError

Constructors

constructor

Properties

code message name options originalMessage response url

Methods

retry

Constructors

constructor

  • new ArcGISAuthError(message?, code?, response?, url?, options?): ArcGISAuthError

  • Create a new ArcGISAuthError object.

    Parameters

    • Optional message: string

      The error message from the API

    • Optional code: string | number

      The error code from the API

    • Optional response: any

      The original response from the API that caused the error

    • Optional url: string

      The original url of the request

    • Optional options: IRequestOptions

      The original options of the request

    Returns ArcGISAuthError

Properties

code

code: string | number

The error code returned from the request.

message

message: string

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

name

name: string

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

options

options: IRequestOptions

The options of the original request that caused the error

originalMessage

originalMessage: string

The errror message return from the request.

response

response: any

The original JSON response the caused the error.

url

url: string

The URL of the original request that caused the error

Methods

retry

  • retry(getSession, retryLimit?): Promise<unknown>

  • Parameters

    • getSession: IRetryAuthError
    • Optional retryLimit: number

    Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

constructorcodemessagenameoptionsoriginalMessageresponseurlretry