@deep/nest-kit
    Preparing search index...

    Class AccessDeniedException

    Represents an exception that is thrown when access to a resource is denied.

    throw new AccessDeniedException({
    action: 'js:core:users:get',
    context: { id: 1 }
    });

    Hierarchy

    • ForbiddenException
      • AccessDeniedException
    Index

    Constructors

    Properties

    cause: unknown

    Exception cause. Indicates the specific original cause of the error. It is used when catching and re-throwing an error with a more-specific or useful error message in order to still have access to the original error.

    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

    • Returns string | object

    • Returns number

    • Returns void

    • Returns void

    • 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

      • nil: null | ""
      • message: HttpExceptionBodyMessage
      • statusCode: number

      Returns HttpExceptionBody

    • Parameters

      • message: HttpExceptionBodyMessage
      • error: string
      • statusCode: number

      Returns HttpExceptionBody

    • Type Parameters

      • Body extends Record<string, unknown>

      Parameters

      Returns Body

    • Utility method used to extract the error description and httpExceptionOptions from the given argument. This is used by inheriting classes to correctly parse both options.

      Parameters

      • descriptionOrOptions: string | HttpExceptionOptions

      Returns DescriptionAndOptions

      the error description and the httpExceptionOptions as an object.

    • Parameters

      • descriptionOrOptions: string | HttpExceptionOptions

      Returns string

    • Parameters

      • descriptionOrOptions: string | HttpExceptionOptions

      Returns HttpExceptionOptions