@depup/nestjs__common 11.1.16-depup.1

package/exceptions/im-a-teapot.exception.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImATeapotException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *ImATeapotException* type errors.
+ *
+ * Any attempt to brew coffee with a teapot should result in the error code
+ * "418 I'm a teapot". The resulting entity body MAY be short and stout.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class ImATeapotException extends http_exception_1.HttpException {
+    /**
+     * Instantiate an `ImATeapotException` Exception.
+     *
+     * @example
+     * `throw new ImATeapotException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 418.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 418.
+     * - `message`: the string `"I'm a Teapot"` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = `I'm a teapot`) {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.I_AM_A_TEAPOT), http_status_enum_1.HttpStatus.I_AM_A_TEAPOT, httpExceptionOptions);
+    }
+}
+exports.ImATeapotException = ImATeapotException;

package/exceptions/index.d.ts

@@ -0,0 +1,23 @@
+export * from './bad-gateway.exception';
+export * from './bad-request.exception';
+export * from './conflict.exception';
+export * from './forbidden.exception';
+export * from './gateway-timeout.exception';
+export * from './gone.exception';
+export * from './http-version-not-supported.exception';
+export * from './http.exception';
+export * from './im-a-teapot.exception';
+export * from './internal-server-error.exception';
+export * from './intrinsic.exception';
+export * from './method-not-allowed.exception';
+export * from './misdirected.exception';
+export * from './not-acceptable.exception';
+export * from './not-found.exception';
+export * from './not-implemented.exception';
+export * from './payload-too-large.exception';
+export * from './precondition-failed.exception';
+export * from './request-timeout.exception';
+export * from './service-unavailable.exception';
+export * from './unauthorized.exception';
+export * from './unprocessable-entity.exception';
+export * from './unsupported-media-type.exception';

package/exceptions/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bad-gateway.exception"), exports);
+tslib_1.__exportStar(require("./bad-request.exception"), exports);
+tslib_1.__exportStar(require("./conflict.exception"), exports);
+tslib_1.__exportStar(require("./forbidden.exception"), exports);
+tslib_1.__exportStar(require("./gateway-timeout.exception"), exports);
+tslib_1.__exportStar(require("./gone.exception"), exports);
+tslib_1.__exportStar(require("./http-version-not-supported.exception"), exports);
+tslib_1.__exportStar(require("./http.exception"), exports);
+tslib_1.__exportStar(require("./im-a-teapot.exception"), exports);
+tslib_1.__exportStar(require("./internal-server-error.exception"), exports);
+tslib_1.__exportStar(require("./intrinsic.exception"), exports);
+tslib_1.__exportStar(require("./method-not-allowed.exception"), exports);
+tslib_1.__exportStar(require("./misdirected.exception"), exports);
+tslib_1.__exportStar(require("./not-acceptable.exception"), exports);
+tslib_1.__exportStar(require("./not-found.exception"), exports);
+tslib_1.__exportStar(require("./not-implemented.exception"), exports);
+tslib_1.__exportStar(require("./payload-too-large.exception"), exports);
+tslib_1.__exportStar(require("./precondition-failed.exception"), exports);
+tslib_1.__exportStar(require("./request-timeout.exception"), exports);
+tslib_1.__exportStar(require("./service-unavailable.exception"), exports);
+tslib_1.__exportStar(require("./unauthorized.exception"), exports);
+tslib_1.__exportStar(require("./unprocessable-entity.exception"), exports);
+tslib_1.__exportStar(require("./unsupported-media-type.exception"), exports);

package/exceptions/internal-server-error.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Internal Server Error* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class InternalServerErrorException extends HttpException {
+    /**
+     * Instantiate an `InternalServerErrorException` Exception.
+     *
+     * @example
+     * `throw new InternalServerErrorException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 500.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 500.
+     * - `message`: the string `'Internal Server Error'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/internal-server-error.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerErrorException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Internal Server Error* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class InternalServerErrorException extends http_exception_1.HttpException {
+    /**
+     * Instantiate an `InternalServerErrorException` Exception.
+     *
+     * @example
+     * `throw new InternalServerErrorException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 500.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 500.
+     * - `message`: the string `'Internal Server Error'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Internal Server Error') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.INTERNAL_SERVER_ERROR), http_status_enum_1.HttpStatus.INTERNAL_SERVER_ERROR, httpExceptionOptions);
+    }
+}
+exports.InternalServerErrorException = InternalServerErrorException;

package/exceptions/intrinsic.exception.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Exception that represents an intrinsic error in the application.
+ * When thrown, the default exception filter will not log the error message.
+ *
+ * @publicApi
+ */
+export declare class IntrinsicException extends Error {
+}

package/exceptions/intrinsic.exception.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntrinsicException = void 0;
+/**
+ * Exception that represents an intrinsic error in the application.
+ * When thrown, the default exception filter will not log the error message.
+ *
+ * @publicApi
+ */
+class IntrinsicException extends Error {
+}
+exports.IntrinsicException = IntrinsicException;

package/exceptions/method-not-allowed.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Method Not Allowed* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class MethodNotAllowedException extends HttpException {
+    /**
+     * Instantiate a `MethodNotAllowedException` Exception.
+     *
+     * @example
+     * `throw new MethodNotAllowedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 405.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 405.
+     * - `message`: the string `'Method Not Allowed'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/method-not-allowed.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodNotAllowedException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Method Not Allowed* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class MethodNotAllowedException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `MethodNotAllowedException` Exception.
+     *
+     * @example
+     * `throw new MethodNotAllowedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 405.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 405.
+     * - `message`: the string `'Method Not Allowed'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Method Not Allowed') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.METHOD_NOT_ALLOWED), http_status_enum_1.HttpStatus.METHOD_NOT_ALLOWED, httpExceptionOptions);
+    }
+}
+exports.MethodNotAllowedException = MethodNotAllowedException;

package/exceptions/misdirected.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Misdirected* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class MisdirectedException extends HttpException {
+    /**
+     * Instantiate a `MisdirectedException` Exception.
+     *
+     * @example
+     * `throw new MisdirectedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 421.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 421.
+     * - `message`: the string `'Bad Gateway'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/misdirected.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MisdirectedException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Misdirected* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class MisdirectedException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `MisdirectedException` Exception.
+     *
+     * @example
+     * `throw new MisdirectedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 421.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 421.
+     * - `message`: the string `'Bad Gateway'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Misdirected') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.MISDIRECTED), http_status_enum_1.HttpStatus.MISDIRECTED, httpExceptionOptions);
+    }
+}
+exports.MisdirectedException = MisdirectedException;

package/exceptions/not-acceptable.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Not Acceptable* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class NotAcceptableException extends HttpException {
+    /**
+     * Instantiate a `NotAcceptableException` Exception.
+     *
+     * @example
+     * `throw new NotAcceptableException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 406.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 406.
+     * - `error`: the string `'Not Acceptable'` by default; override this by supplying
+     * a string in the `error` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/not-acceptable.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotAcceptableException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Not Acceptable* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class NotAcceptableException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `NotAcceptableException` Exception.
+     *
+     * @example
+     * `throw new NotAcceptableException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 406.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 406.
+     * - `error`: the string `'Not Acceptable'` by default; override this by supplying
+     * a string in the `error` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Not Acceptable') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.NOT_ACCEPTABLE), http_status_enum_1.HttpStatus.NOT_ACCEPTABLE, httpExceptionOptions);
+    }
+}
+exports.NotAcceptableException = NotAcceptableException;

package/exceptions/not-found.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Not Found* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class NotFoundException extends HttpException {
+    /**
+     * Instantiate a `NotFoundException` Exception.
+     *
+     * @example
+     * `throw new NotFoundException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 404.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 404.
+     * - `message`: the string `'Not Found'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/not-found.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Not Found* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class NotFoundException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `NotFoundException` Exception.
+     *
+     * @example
+     * `throw new NotFoundException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 404.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 404.
+     * - `message`: the string `'Not Found'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Not Found') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.NOT_FOUND), http_status_enum_1.HttpStatus.NOT_FOUND, httpExceptionOptions);
+    }
+}
+exports.NotFoundException = NotFoundException;

package/exceptions/not-implemented.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Not Implemented* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class NotImplementedException extends HttpException {
+    /**
+     * Instantiate a `NotImplementedException` Exception.
+     *
+     * @example
+     * `throw new NotImplementedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 501.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 501.
+     * - `message`: the string `'Not Implemented'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     * @param error a short description of the HTTP error.
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/not-implemented.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotImplementedException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Not Implemented* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class NotImplementedException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `NotImplementedException` Exception.
+     *
+     * @example
+     * `throw new NotImplementedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 501.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 501.
+     * - `message`: the string `'Not Implemented'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     * @param error a short description of the HTTP error.
+     */
+    constructor(objectOrError, descriptionOrOptions = 'Not Implemented') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.NOT_IMPLEMENTED), http_status_enum_1.HttpStatus.NOT_IMPLEMENTED, httpExceptionOptions);
+    }
+}
+exports.NotImplementedException = NotImplementedException;

package/exceptions/payload-too-large.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Payload Too Large* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class PayloadTooLargeException extends HttpException {
+    /**
+     * Instantiate a `PayloadTooLargeException` Exception.
+     *
+     * @example
+     * `throw new PayloadTooLargeException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 413.
+     * - The `objectOrError` argument defines the JSON response body or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 413.
+     * - `message`: the string `'Payload Too Large'` by default; override this by supplying
+     * a string in the `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, with a short description of the HTTP error. To override the
+     * entire JSON response body, pass an object instead. Nest will serialize the object
+     * and return it as the JSON response body.
+     *
+     * @param objectOrError string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(objectOrError?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}