Class SyncError

The error type of the engine. code is stable across versions; message is written for people and never contains a secret.

Hierarchy

Error
- SyncError

Index

Constructors

constructor

Properties

code details serverCode transient

Constructors

constructor

new SyncError(
    code: SyncErrorCode,
    message: string,
    options?: SyncErrorOptions,
): SyncError
Parameters
- code: SyncErrorCode
- message: string
- options: SyncErrorOptions = {}
Returns SyncError
Overrides Error.constructor
- Defined in errors.ts:66

Properties

`Readonly`code

code: SyncErrorCode

What went wrong, stable across versions, for programs to act on.

`Readonly`details

details: SyncErrorDetails | undefined

Facts a program can act on, such as why a sign-in failed or which certificate did not verify.

`Readonly`serverCode

serverCode: number | undefined

The server's reply code, when the server gave one.

`Readonly`transient

transient: boolean

True when trying again, on a fresh connection, may succeed.

Class SyncError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns SyncError

Properties

`Readonly`code

`Readonly`details

`Readonly`serverCode

`Readonly`transient

Settings

On This Page

Class SyncError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns SyncError

Properties

Readonlycode

Readonlydetails

ReadonlyserverCode

Readonlytransient

Settings

On This Page

`Readonly`code

`Readonly`details

`Readonly`serverCode

`Readonly`transient