Skip to content

Class: PolicyViolationError ​

Defined in: errors.ts:333

A configured security policy (for example CNSA 2.0 enforcement) rejected an algorithm.

Extends ​

Constructors ​

Constructor ​

new PolicyViolationError(message): PolicyViolationError

Defined in: errors.ts:338

Creates the error with code QS_POLICY_VIOLATION.

Parameters ​

message ​

string

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

Returns ​

PolicyViolationError

Overrides ​

QuantumSafeError.constructor

Properties ​

code ​

readonly code: QsErrorCode

Defined in: errors.ts:65

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

Inherited from ​

QuantumSafeError.code


hint ​

readonly hint: string

Defined in: errors.ts:67

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

Inherited from ​

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

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

QuantumSafeError.is

Apache-2.0.