Class: KeyParseError

Defined in: errors.ts:259

A key could not be parsed from PEM, CBOR or JWK.

Extends

• SerializationError

Constructors

Constructor

new KeyParseError(message): KeyParseError

Defined in: errors.ts:264

Creates the error with code QS_KEY_PARSE_ERROR.

Parameters

message

string

Description of the failure; contains no key material or caller input.

Returns

KeyParseError

Overrides

SerializationError.constructor

Properties

code

readonly code: QsErrorCode

Defined in: errors.ts:65

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

Inherited from

SerializationError.code

---

hint

readonly hint: string

Defined in: errors.ts:67

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

Inherited from

SerializationError.hint

Methods

toJSON()

toJSON(): object

Defined in: errors.ts:98

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

Returns

object

name, code, message and hint; contains no key material.

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:90

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

Any value.

Returns

e is QuantumSafeError

true when e is an object carrying this library's error brand.

Inherited from

SerializationError.is