-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathtypes.w
67 lines (62 loc) · 1.27 KB
/
types.w
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
pub struct SpecProps {
outputDirectory: str?;
specVersion: num?;
}
pub struct StartServiceOptions {
currentdir: str;
basedir: str;
workdir: str;
options: ServiceProps;
homeEnv: str;
pathEnv: str;
clients: Map<std.Resource>;
lastPort: str?;
}
/**
* Properties for a new TSOA service.
*/
pub struct ServiceProps {
/**
* The entry point to your API
*/
entryFile: str?;
/**
* An array of path globs that point to your route controllers that you would like to have tsoa include.
*/
controllerPathGlobs: Array<str>;
/**
* Generated SwaggerConfig.json will output here
*/
outputDirectory: str;
/**
* Extend generated swagger spec with this object
*/
spec: SpecProps?;
/**
* Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here
*/
routesDir: str;
/**
* Directory of source files to watch for changes
*/
watchDir: str?;
}
/**
* Options for the lift method.
*/
pub struct LiftOptions {
/**
* Id of the client
*/
id: str;
/**
* List of operations to allow for this client
*/
allow: Array<str>;
}
/**
* Starts a new TSOA service.
*/
pub interface IService {
lift(client: std.Resource, ops: LiftOptions): void;
}