Setu-TS
    Preparing search index...

    Class OutboxStoreUnavailableError

    Rejected by verify() of the store createDatabaseOutboxStore builds when the configured backend cannot serve the outbox.

    The outbox runs verify() at startup, before it schedules the relay or accepts a write, so an unusable backend is a named startup failure rather than a relay that fails every tick. The adapter's own error is kept as cause for the log; the message names the entity and the reason, never a row's contents.

    import { OutboxStoreUnavailableError } from '@setu-ts/database-plugin';

    try {
      await app.start({ port: 3000 });
    } catch (error) {
      if (error instanceof OutboxStoreUnavailableError && error.reason === 'mongodb-replica-set') {
        // run MongoDB as a replica set
      }
      throw error;
    }

    0.9.0

    Hierarchy

    • Error
      • OutboxStoreUnavailableError
    Index
    constructor
    cause? entity message name reason stack? stackTraceLimit
    captureStackTrace prepareStackTrace

    • Creates the error.

      Parameters

      • entity: string

        The outbox entity the store was configured with

      • reason:
            | "bigtable"
            | "dynamodb-index"
            | "mongodb-replica-set"
            | "entity-unavailable"
            | "conditional-writes-unsupported"

        Why the backend cannot serve the outbox

      • Optionaloptions: ErrorOptions

        Native error options; cause is the adapter's refusal

      Returns OutboxStoreUnavailableError

    cause?: unknown
    entity: string

    The outbox entity the store was configured with.

    message: string
    name: "OutboxStoreUnavailableError" = 'OutboxStoreUnavailableError'

    Discriminant for consumers that cannot use instanceof across realms.

    reason:
        | "bigtable"
        | "dynamodb-index"
        | "mongodb-replica-set"
        | "entity-unavailable"
        | "conditional-writes-unsupported"

    Why the backend cannot serve the outbox — a fixed vocabulary, so an application can branch on it without matching message text:

    • 'bigtable' — Bigtable has no secondary index, so the relay query (pending rows in position order) cannot run; a change-data-capture relay is the remedy.
    • 'dynamodb-index' — DynamoDB orders only by an access path's sort key, and no GSI { partitionKey: 'status', sortKey: 'position' } is configured for the outbox entity.
    • 'mongodb-replica-set' — the server refused a transaction (code 20, IllegalOperation): MongoDB transactions need a replica set.
    • 'entity-unavailable' — anything else: the outbox entity is missing or unreadable.
    • 'conditional-writes-unsupported' — the source cannot take and guard claims with native conditional writes.
    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

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods