Skip to main content

Class: ComplianceError

Defined in: src/types/errors.ts:112

AT Protocol compliance violation error.

Remarks​

Thrown when code attempts to violate AT Protocol AppView principles:

  • Writing to user PDSes (forbidden)
  • Storing blob data instead of BlobRefs (forbidden)
  • Creating non-rebuildable indexes (forbidden)
  • Missing PDS source tracking (required)

These errors indicate critical bugs that must be fixed before release. All compliance violations should be caught by automated tests.

Example​

if (operation === 'WRITE_TO_PDS') {
  throw new ComplianceError(
    'WRITE_TO_PDS',
    'AppViews must never write to user PDSes'
  );
}

Extends​

Constructors​

new ComplianceError()​

new ComplianceError(violationType, message): ComplianceError

Defined in: src/types/errors.ts:133

Creates a new ComplianceError.

Parameters​

violationType​

Specific type of compliance violation

"WRITE_TO_PDS" | "BLOB_STORAGE" | "MISSING_SOURCE_TRACKING" | "NON_REBUILDABLE"

message​

string

Description of the violation

Returns​

ComplianceError

Overrides​

ChiveError.constructor

Properties​

cause?​

readonly optional cause: Error

Defined in: src/types/errors.ts:71

Original error that caused this error (if any).

Remarks​

Error chaining allows tracking the full error context through multiple layers of the application. Useful for debugging complex error scenarios.

Example​

try {
  await fetchData();
} catch (err) {
  throw new ValidationError('Failed to validate data', 'field', 'required', err as Error);
}

Inherited from​

ChiveError.cause

code​

readonly code: "COMPLIANCE_VIOLATION" = 'COMPLIANCE_VIOLATION'

Defined in: src/types/errors.ts:113

Machine-readable error code.

Remarks​

Error codes are unique identifiers for error types, enabling programmatic error handling (switch statements, error maps), error tracking in monitoring systems, and client-side error translation (i18n).

Overrides​

ChiveError.code

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.5.4/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

ChiveError.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@5.5.4/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

ChiveError.name

stack?​

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.5.4/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

ChiveError.stack

violationType​

readonly violationType: "WRITE_TO_PDS" | "BLOB_STORAGE" | "MISSING_SOURCE_TRACKING" | "NON_REBUILDABLE"

Defined in: src/types/errors.ts:121

Type of compliance violation.

Remarks​

Specific violation types enable targeted error handling and reporting.

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

ChiveError.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

ChiveError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@24.10.1/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

ChiveError.prepareStackTrace