Member Junction
    Preparing search index...

    Thrown by RedisLocalStorageProvider.WithKeyLock when the lock could not be taken in time — distinct from anything work itself throws, so a caller can tell "another process is holding this slot" (fall back to invalidating it) from "my own read-modify-write is broken" (a bug, which must not be silently downgraded to an invalidation).

    Hierarchy

    • Error
      • KeyLockTimeoutError
    Index

    Constructors

    • Parameters

      • LockKey: string

        The lock that could not be taken.

      • waitedMs: number

        How long the attempt waited.

      • Optionalreason: string

        Why, when it was not contention — e.g. Redis being unreachable. Defaults to the contention message. The class (and so its name) is kept either way, because the caller's correct response is the same: do not write, invalidate instead.

      Returns KeyLockTimeoutError

    Properties

    cause?: unknown
    LockKey: string

    The lock that could not be taken.

    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.

    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

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any