Setu-TS
    Preparing search index...

    Class DuplicateKeyError

    Thrown when a write would duplicate a primary key or a unique index.

    The write did not happen, and repeating it unchanged fails the same way: unlike a serialization conflict this is not a retryable condition. The response is 409 Conflict with a fixed detail; the driver error is kept as cause for the log and never served, because a driver message can quote the duplicated value (PostgreSQL's detail reads Key (email)=(…) already exists).

    import { DuplicateKeyError } from '@setu-ts/common';

    try {
      await repository.create({ id: 'u1', email: 'ada@example.com' });
    } catch (error) {
      if (error instanceof DuplicateKeyError) {
        // A row with that key or unique value already exists.
      }
    }

    0.9.0

    Hierarchy

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

    • Builds the error. The message is the full diagnostic, safe to log and never served.

      Parameters

      • message: string

        The full diagnostic

      • Optionaloptions: { cause?: unknown; entity?: string }

        The entity the write targeted, and the driver error as cause

      Returns DuplicateKeyError

    cause?: unknown
    entity: string | undefined

    The entity the write targeted, when the producer knows it. A refusal raised at transaction commit, where several entities may be written at once, carries none.

    message: string
    name: "DuplicateKeyError" = 'DuplicateKeyError'

    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

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods