UNPKG

947 BTypeScriptView Raw
1import { VersioningOptions } from '@nestjs/common';
2import { VersionValue } from '@nestjs/common/interfaces';
3export interface RoutePathMetadata {
4 /**
5 * Controller-level path (e.g., @Controller('resource') = "resource").
6 */
7 ctrlPath?: string;
8 /**
9 * Method-level path (e.g., @Get('resource') = "resource").
10 */
11 methodPath?: string;
12 /**
13 * Global route prefix specified with the "NestApplication#setGlobalPrefix" method.
14 */
15 globalPrefix?: string;
16 /**
17 * Module-level path registered through the "RouterModule".
18 */
19 modulePath?: string;
20 /**
21 * Controller-level version (e.g., @Controller({ version: '1.0' }) = "1.0").
22 */
23 controllerVersion?: VersionValue;
24 /**
25 * Method-level version (e.g., @Version('1.0') = "1.0").
26 */
27 methodVersion?: VersionValue;
28 /**
29 * API versioning options object.
30 */
31 versioningOptions?: VersioningOptions;
32}