/
nest-express-application.interface.ts
106 lines (97 loc) 路 2.4 KB
/
nest-express-application.interface.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
import { Server } from 'net';
import { INestApplication } from '@nestjs/common';
import { ServeStaticOptions } from './serve-static-options.interface';
/**
* Interface describing methods on NestExpressApplication.
*
* @see [Platform](https://docs.nestjs.com/first-steps#platform)
*
* @publicApi
*/
export interface NestExpressApplication extends INestApplication {
/**
* Starts the application.
*
* @param {number|string} port
* @param {string} [hostname]
* @param {Function} [callback] Optional callback
* @returns {Promise} A Promise that, when resolved, is a reference to the underlying HttpServer.
*/
listen(port: number | string, callback?: () => void): Promise<Server>;
listen(
port: number | string,
hostname: string,
callback?: () => void,
): Promise<Server>;
/**
* A wrapper function around native `express.set()` method.
*
* @example
* app.set('trust proxy', 'loopback')
*
* @returns {this}
*/
set(...args: any[]): this;
/**
* A wrapper function around native `express.engine()` method.
* @example
* app.engine('mustache', mustacheExpress())
*
* @returns {this}
*/
engine(...args: any[]): this;
/**
* A wrapper function around native `express.enable()` method.
* @example
* app.enable('x-powered-by')
*
* @returns {this}
*/
enable(...args: any[]): this;
/**
* A wrapper function around native `express.disable()` method.
*
* @example
* app.disable('x-powered-by')
*
* @returns {this}
*/
disable(...args: any[]): this;
useStaticAssets(options: ServeStaticOptions): this;
/**
* Sets a base directory for public assets.
* @example
* app.useStaticAssets('public')
*
* @returns {this}
*/
useStaticAssets(path: string, options?: ServeStaticOptions): this;
/**
* Sets one or multiple base directories for templates (views).
*
* @example
* app.setBaseViewsDir('views')
*
* @returns {this}
*/
setBaseViewsDir(path: string | string[]): this;
/**
* Sets a view engine for templates (views).
* @example
* app.setViewEngine('pug')
*
* @returns {this}
*/
setViewEngine(engine: string): this;
/**
* Sets app-level globals for view templates.
*
* @example
* app.setLocal('title', 'My Site')
*
* @see https://expressjs.com/en/4x/api.html#app.locals
*
* @returns {this}
*/
setLocal(key: string, value: any): this;
}