@nestjs/common/decorators/core/use-interceptors.decorator.js

Nest - modern, fast, powerful node.js web framework (@common)

import { INTERCEPTORS_METADATA } from '../../constants.js';
import { extendArrayMetadata } from '../../utils/extend-metadata.util.js';
import { isFunction } from '../../utils/shared.utils.js';
import { validateEach } from '../../utils/validate-each.util.js';
/**
 * Decorator that binds interceptors to the scope of the controller or method,
 * depending on its context.
 *
 * When `@UseInterceptors` is used at the controller level, the interceptor will
 * be applied to every handler (method) in the controller.
 *
 * When `@UseInterceptors` is used at the individual handler level, the interceptor
 * will apply only to that specific method.
 *
 * @param interceptors a single interceptor instance or class, or a list of
 * interceptor instances or classes.
 *
 * @see [Interceptors](https://docs.nestjs.com/interceptors)
 *
 * @usageNotes
 * Interceptors can also be set up globally for all controllers and routes
 * using `app.useGlobalInterceptors()`.  [See here for details](https://docs.nestjs.com/interceptors#binding-interceptors)
 *
 * @publicApi
 */
export function UseInterceptors(...interceptors) {
    return (target, key, descriptor) => {
        const isInterceptorValid = (interceptor) => interceptor &&
            (isFunction(interceptor) || isFunction(interceptor.intercept));
        if (descriptor) {
            validateEach(target.constructor, interceptors, isInterceptorValid, '@UseInterceptors', 'interceptor');
            extendArrayMetadata(INTERCEPTORS_METADATA, interceptors, descriptor.value);
            return descriptor;
        }
        validateEach(target, interceptors, isInterceptorValid, '@UseInterceptors', 'interceptor');
        extendArrayMetadata(INTERCEPTORS_METADATA, interceptors, target);
        return target;
    };
}