@authgear/capacitor / ServerError
Class: ServerError
ServerError represents error received from the server.
Hierarchy
-
↳
ServerError
Table of contents
Constructors
Properties
Constructors
constructor
• new ServerError(message, name, reason, info?): ServerError
Parameters
| Name | Type |
|---|---|
message | string |
name | string |
reason | string |
info? | unknown |
Returns
Overrides
Defined in
packages/authgear-capacitor/index.d.ts:230
Properties
info
• Optional info: unknown
Additional error information.
Defined in
packages/authgear-capacitor/index.d.ts:229
message
• message: string
Error message.
Remarks
Error messages are provided for convenience, and not stable APIs; Consumers should use ServerError.name or ServerError.reason to distinguish between different errors.
Overrides
AuthgearError.message
Defined in
packages/authgear-capacitor/index.d.ts:221
name
• name: string
Error name.
Remarks
See ErrorName for possible values. New error names may be added in future.
Overrides
AuthgearError.name
Defined in
packages/authgear-capacitor/index.d.ts:212
reason
• reason: string
Error reason.
Defined in
packages/authgear-capacitor/index.d.ts:225
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
Defined in
packages/authgear-capacitor/index.d.ts:14