UNPKG

2.14 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3exports.UseFilters = void 0;
4/* eslint-disable @typescript-eslint/no-use-before-define */
5const constants_1 = require("../../constants");
6const extend_metadata_util_1 = require("../../utils/extend-metadata.util");
7const shared_utils_1 = require("../../utils/shared.utils");
8const validate_each_util_1 = require("../../utils/validate-each.util");
9/**
10 * Decorator that binds exception filters to the scope of the controller or
11 * method, depending on its context.
12 *
13 * When `@UseFilters` is used at the controller level, the filter will be
14 * applied to every handler (method) in the controller.
15 *
16 * When `@UseFilters` is used at the individual handler level, the filter
17 * will apply only to that specific method.
18 *
19 * @param filters exception filter instance or class, or a list of exception
20 * filter instances or classes.
21 *
22 * @see [Exception filters](https://docs.nestjs.com/exception-filters)
23 *
24 * @usageNotes
25 * Exception filters can also be set up globally for all controllers and routes
26 * using `app.useGlobalFilters()`. [See here for details](https://docs.nestjs.com/exception-filters#binding-filters)
27 *
28 * @publicApi
29 */
30const UseFilters = (...filters) => addExceptionFiltersMetadata(...filters);
31exports.UseFilters = UseFilters;
32function addExceptionFiltersMetadata(...filters) {
33 return (target, key, descriptor) => {
34 const isFilterValid = (filter) => filter &&
35 ((0, shared_utils_1.isFunction)(filter) || (0, shared_utils_1.isFunction)(filter.catch));
36 if (descriptor) {
37 (0, validate_each_util_1.validateEach)(target.constructor, filters, isFilterValid, '@UseFilters', 'filter');
38 (0, extend_metadata_util_1.extendArrayMetadata)(constants_1.EXCEPTION_FILTERS_METADATA, filters, descriptor.value);
39 return descriptor;
40 }
41 (0, validate_each_util_1.validateEach)(target, filters, isFilterValid, '@UseFilters', 'filter');
42 (0, extend_metadata_util_1.extendArrayMetadata)(constants_1.EXCEPTION_FILTERS_METADATA, filters, target);
43 return target;
44 };
45}