Skip to main content

ServerError

@authgear/react-native / ServerError

Class: ServerError

ServerError represents error received from the server.

Hierarchy

Table of contents

Constructors

Properties

Constructors

constructor

new ServerError(message, name, reason, info?)

Parameters

NameType
messagestring
namestring
reasonstring
info?unknown

Overrides

AuthgearError.constructor

Defined in

packages/authgear-react-native/index.d.ts:134

Properties

info

Optional info: unknown

Additional error information.

Defined in

packages/authgear-react-native/index.d.ts:133


message

message: string

Error message.

Remarks

Error messages are provided for convenience, and not stable APIs; Consumers should use name or reason to distinguish between different errors.

Overrides

AuthgearError.message

Defined in

packages/authgear-react-native/index.d.ts:125


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-react-native/index.d.ts:116


reason

reason: string

Error reason.

Defined in

packages/authgear-react-native/index.d.ts:129


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-react-native/index.d.ts:14