@authgear/capacitor / AuthgearError

Class: AuthgearError

AuthgearError is the root class of error produced by the SDK.

Hierarchy

• Error

  ↳ AuthgearError

  ↳↳ CancelError

  ↳↳ OAuthError

  ↳↳ PreAuthenticatedURLNotAllowedError

  ↳↳ ServerError

  ↳↳ BiometricLockoutError

  ↳↳ BiometricNoEnrollmentError

  ↳↳ BiometricNoPasscodeError

  ↳↳ BiometricNotSupportedOrPermissionDeniedError

  ↳↳ BiometricPrivateKeyNotFoundError

Table of contents

Constructors

• constructor

Properties

• underlyingError

Constructors

constructor

• new AuthgearError(message?): AuthgearError

Parameters

Name	Type
message?	string

Returns

AuthgearError

Inherited from

Error.constructor

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1082

Properties

underlyingError

• Optional underlyingError: unknown

underlyingError is the underlying error. The type is unknown because it is possible to throw anything in JavaScript. Use ordinary approaches, such as instanceof operator, to identify what it is.

Defined in

packages/authgear-capacitor/index.d.ts:14