@earth-app/collegedb
    Preparing search index...

    Class CollegeDBError

    Custom error class for CollegeDB operations

    Extends the native Error class to provide more specific error information for CollegeDB operations. Includes an optional error code for better error categorization and handling.

    try {
      await getShardForKey('invalid-key');
    } catch (error) {
      if (error instanceof CollegeDBError) {
        console.error(`CollegeDB Error (${error.code}): ${error.message}`);
      }
    }

    Hierarchy

    • Error
      • CollegeDBError
    Index
    constructor
    cause? code? message name stack? stackTraceLimit
    captureStackTrace isError prepareStackTrace

    • Creates a new CollegeDBError instance

      Parameters

      • message: string

        Error message describing what went wrong

      • Optionalcode: string

        Optional error code for categorization

      Returns CollegeDBError

      throw new CollegeDBError('Shard not found', 'SHARD_NOT_FOUND');
    cause?: unknown

    The cause of the error.

    code?: string

    Optional error code for categorizing different types of errors

    message: string
    name: string
    stack?: string
    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.

    • 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

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    • Check if a value is an instance of Error

      Parameters

      • value: unknown

        The value to check

      Returns value is Error

      True if the value is an instance of Error, false otherwise

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods