MCPcopy
hub / github.com/lukeautry/tsoa / ParameterController

Class ParameterController

tests/fixtures/controllers/parameterController.ts:5–409  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

3
4@Route('ParameterTest')
5export class ParameterController {
6 /**
7 * Example test parameter
8 *
9 * @example firstname "name1"
10 * @example firstname "name2"
11 * @example lastname "lastname"
12 * @example gender {
13 * "MALE": "MALE",
14 * "FEMALE": "FEMALE"
15 * }
16 * @example gender {
17 * "MALE": "MALE2",
18 * "FEMALE": "FEMALE2"
19 * }
20 * @example nicknames [
21 * "name1", "name2"
22 * ]
23 * @example nicknames [
24 * "name2_1", "name2_2"
25 * ]
26 */
27 @Post('Example/{firstname}')
28 public async example(@Path() firstname: string, @Query() lastname: string, @Body() gender: Gender, @Query() nicknames: string[]): Promise<void> {
29 return;
30 }
31
32 /**
33 * Query test paramater
34 *
35 * @param {string} firstname Firstname description
36 * @param {string} lastname Lastname description
37 * @param {number} age Age description
38 * @param {number} weight Weight description
39 * @param {boolean} human Human description
40 * @param {Gender} gender Gender description
41 * @param {string[]} nicknames Nicknames description
42 *
43 * @isInt age
44 * @isFloat weight
45 *
46 * @example lastname "name1"
47 * @example lastname "name2"
48 */
49 @Get('Query')
50 public async getQuery(
51 @Query() firstname: string,
52 @Query('last_name') lastname: string,
53 @Query() age: number,
54 @Query() weight: number,
55 @Query() human: boolean,
56 @Query() gender: Gender,
57 @Query() nicknames: string[],
58 ): Promise<ParameterTestModel> {
59 return Promise.resolve<ParameterTestModel>({
60 age,
61 firstname,
62 gender,

Callers

nothing calls this directly

Calls 2

PostFunction · 0.90
GetFunction · 0.90

Tested by

no test coverage detected