middleware-config-proxy.interface.ts

import { Type } from '../type.interface';
import { RouteInfo } from './middleware-configuration.interface';
import { MiddlewareConsumer } from './middleware-consumer.interface';

/**
 * @publicApi
 */
export interface MiddlewareConfigProxy {
  /**
   * Routes to exclude from the current middleware.
   *
   * @param {(string | RouteInfo)[]} routes
   * @returns {MiddlewareConfigProxy}
   */
  exclude(...routes: (string | RouteInfo)[]): MiddlewareConfigProxy;

  /**
   * Attaches either routes or controllers to the current middleware.
   * If you pass a controller class, Nest will attach the current middleware to every path
   * defined within it.
   *
   * @param {(string | Type | RouteInfo)[]} routes
   * @returns {MiddlewareConsumer}
   */
  forRoutes(...routes: (string | Type<any> | RouteInfo)[]): MiddlewareConsumer;
}