Class AttestationError

The single error type thrown by @me2em/core: a failure with a stable code, the level that produced it and a message prefixed with [<level>/<code>] for human diagnostics.

Every failure — including token parsing, issuance validation and Session.verifyStateless — throws this type; there is no plain-Error path left in the package. DisposedError is a subclass with the DISPOSED code, so a single catch (e) { if (e instanceof AttestationError) … } covers the whole surface.

Example

import { AttestationError } from '@me2em/core';

try {
  await Session.verifyAttested(token, rootPub, chain, 'ev-app.com');
} catch (e) {
  if (e instanceof AttestationError) {
    // e.g. code 'SCOPE_EXCEEDED', level 'SESSION'
    log.warn(`${e.level}/${e.code}`);
  }
  throw new Error('Unauthorized');
}

Hierarchy (view full)

Constructors

constructor

Properties

stackTraceLimit cause? name message stack? code level

Methods

captureStackTrace prepareStackTrace

Constructors

constructor

Properties

StaticstackTraceLimit

stackTraceLimit: number

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.

Optionalcause

cause?: unknown

name

name: string

message

message: string

Optionalstack

stack?: string

Readonlycode

code: AttestationErrorCode

Stable machine-readable failure code — match on this, not on messages.

Readonlylevel

level: AttestationLevel

Layer that produced the failure (see AttestationLevel).

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • 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
    • OptionalconstructorOpt: Function

    Returns void

StaticprepareStackTrace

Settings

Member Visibility

On This Page

Constructors
Properties
Methods