@authgear/capacitor / OAuthError

Class: OAuthError

OAuthError represents the oauth error response. https://tools.ietf.org/html/rfc6749#section-4.1.2.1

Hierarchy

• AuthgearError

  ↳ OAuthError

Table of contents

Constructors

• constructor

Properties

• error
• error_description
• error_uri
• state
• underlyingError

Constructors

constructor

• new OAuthError(«destructured»): OAuthError

Parameters

Name	Type
«destructured»	Object
› error	string
› error_description?	string
› error_uri?	string
› state?	string

Returns

OAuthError

Overrides

AuthgearError.constructor

Defined in

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

Properties

error

• error: string

Defined in

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

---

error_description

• Optional error_description: string

Defined in

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

---

error_uri

• Optional error_uri: string

Defined in

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

---

state

• Optional state: string

Defined in

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

---

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.

Inherited from

AuthgearError.underlyingError

Defined in

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