Setu-TS
    Preparing search index...

    Class DatabaseUnavailableError

    Thrown when the database, its connection pool, or its network is temporarily unreachable (X35-2, M90f). The operation did not happen and may be retried.

    The condition reaches the client as 503 Service Unavailable — the load-shedding status — instead of a masked 500. No Retry-After is carried, and the hint channel cannot carry one: ErrorResponseInit has no header channel, and the framework holds no honest value to invent — a pool's saturation has no published horizon. 503 is itself the retryable signal (RFC 9110), and the rate limiter's Retry-After (which does know its reset point) is the deliberate asymmetry, recorded in PUBLIC_API.md.

    import { DatabaseUnavailableError } from '@setu-ts/database-plugin';
    try {
    await repo.findAll(query);
    } catch (err) {
    if (err instanceof DatabaseUnavailableError) {
    // Back off and retry: the pool or connection is saturated.
    }
    }

    0.5.0

    Hierarchy

    • Error
      • DatabaseUnavailableError
    Index
    • Creates the error. The message is the full diagnostic — safe to log, never to serve.

      Parameters

      • message: string

        The full diagnostic, safe to log

      • Optionaloptions: { cause?: unknown }

        The original driver error, preserved as cause

      Returns DatabaseUnavailableError

    cause?: unknown
    message: string
    name: "DatabaseUnavailableError" = 'DatabaseUnavailableError'

    Discriminant for consumers that cannot use instanceof across realms.

    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

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any