Skip to Content
Packages@tuwaio/siwx-coreClassesSiwxPolicyViolationError

SiwxPolicyViolationError

Defined in: errors.ts:127 

Base class of the policy violation errors. Code: SIWX_POLICY_VIOLATION, or a specific code set by a subclass.

The SIWX functions report policy violations as strings (see validatePolicy) and never throw this class or its subclasses. They are provided for applications that want to throw typed errors from their own checks.

Extends

Extended by

Constructors

Constructor

new SiwxPolicyViolationError(message, code?): SiwxPolicyViolationError

Defined in: errors.ts:132 

Parameters

message

string

Human-readable description of the violation.

code?

string = 'SIWX_POLICY_VIOLATION'

Machine-readable error code. Defaults to SIWX_POLICY_VIOLATION.

Returns

SiwxPolicyViolationError

Overrides

SiwxError.constructor

Properties

code

readonly code: string = 'SIWX_ERROR'

Defined in: errors.ts:18 

Machine-readable error code, for example SIWX_PARSE_ERROR. Each subclass passes its own code; SIWX_ERROR is used only by the base class.

Inherited from

SiwxError.code

Last updated on