Skip to content

Class: UnsupportedFormatError ​

Defined in: errors.ts:227

The requested serialization is not supported (for example, a secret key as JWK).

Extends ​

Constructors ​

Constructor ​

new UnsupportedFormatError(message): UnsupportedFormatError

Defined in: errors.ts:228

Parameters ​

message ​

string

Returns ​

UnsupportedFormatError

Overrides ​

SerializationError.constructor

Properties ​

code ​

readonly code: QsErrorCode

Defined in: errors.ts:63

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

Inherited from ​

SerializationError.code


hint ​

readonly hint: string

Defined in: errors.ts:65

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

Inherited from ​

SerializationError.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 ​

SerializationError.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 ​

SerializationError.is

Apache-2.0.