Class DisposedError

Thrown when a method that requires key material is called on an Identity or a Handle/SubHandle that has been disposed via Identity.dispose / Handle.dispose.

The private key bytes are zeroized by dispose(); calling a capability method afterwards is always a programming error, never a recoverable state — match on e.name === 'DisposedError' (or instanceof). As an AttestationError subclass it carries code === 'DISPOSED' and level === 'FORMAT'.

Hierarchy (view full)

Constructors

Properties

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.

cause?: unknown
name: string
message: string
stack?: string
className: string

Name of the disposed class, e.g. 'Identity', 'Handle', 'SubHandle'.

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

Layer that produced the failure (see AttestationLevel).

Methods

  • 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