jsm-exceptions/dist/forbidden.exception.js

A comprehensive TypeScript exception library with HTTP status code support, detailed JSDoc documentation, and backward compatibility. Provides structured error handling for web applications and APIs.

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const base_exception_1 = __importDefault(require("./base.exception"));
/**
 * @fileoverview Forbidden exception (HTTP 403)
 * @author dr. Salmi <reevosolutions@gmail.com>
 */
/**
 * Exception thrown when the client does not have permission to access a resource.
 * Corresponds to HTTP 403 Forbidden status code.
 *
 * @class ForbiddenException
 * @extends {BaseException}
 * @example
 * ```typescript
 * throw new ForbiddenException('Access denied');
 * throw new ForbiddenException('Insufficient permissions', {
 *   requiredRole: 'admin',
 *   userRole: 'user'
 * });
 * ```
 */
class ForbiddenException extends base_exception_1.default {
    /**
     * Creates an instance of ForbiddenException.
     *
     * @param {string} [message='Forbidden'] - The error message
     * @param {Record<string, any>} [context] - Additional context about the permission denial
     * @memberof ForbiddenException
     */
    constructor(message = 'Forbidden', context) {
        super(message, 403, context);
    }
}
exports.default = ForbiddenException;