Class: SerializationError

Defined in: errors.ts:199

Serialization or parsing failure.

Extends

• QuantumSafeError

Extended by

• KeyParseError
• IncompatibleKeyVersionError
• PayloadTooLargeError
• UnsupportedFormatError

Constructors

Constructor

new SerializationError(message, code?, hint?): SerializationError

Defined in: errors.ts:67

Parameters

message

string

code?

QsErrorCode = 'QS_ERROR'

hint?

string = ''

Returns

SerializationError

Inherited from

QuantumSafeError.constructor

Properties

code

readonly code: QsErrorCode

Defined in: errors.ts:63

Stable machine-readable identifier, e.g. QS_DECRYPTION_FAILED.

Inherited from

QuantumSafeError.code

---

hint

readonly hint: string

Defined in: errors.ts:65

One-line, static suggestion for fixing the problem. Contains no sensitive data.

Inherited from

QuantumSafeError.hint

Methods

toJSON()

toJSON(): object

Defined in: errors.ts:85

JSON-safe description, useful for logs and for coding agents.

Returns

object

code

code: QsErrorCode

hint

hint: string

message

message: string

name

name: string

Inherited from

QuantumSafeError.toJSON

---

is()

static is(e): e is QuantumSafeError

Defined in: errors.ts:80

True for errors from any copy of this library. Prefer this to instanceof when an application might load both the ESM and the CommonJS build (each has its own class objects).

Parameters

e

unknown

Returns

e is QuantumSafeError

Inherited from

QuantumSafeError.is