Skip to content

Commit ec465dc

Browse files
author
mkefd
committed
mappersmith jsdoc
1 parent c4ec74b commit ec465dc

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

src/templates/core/mappersmith/request.hbs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,27 @@ export type {{{clientName}}}Client = {
2525
{{#each services}}
2626
{{name}}: {
2727
{{#each operations}}
28+
/**
29+
{{#if deprecated}}
30+
* @deprecated
31+
{{/if}}
32+
{{#if summary}}
33+
* {{{escapeComment summary}}}
34+
{{/if}}
35+
{{#if description}}
36+
* {{{escapeComment description}}}
37+
{{/if}}
38+
{{#if parameters}}
39+
* @param {Object} {{#if hasDefault}}[{{/if}}params{{#if hasDefault}}]{{/if}} - Request parameters.
40+
{{#each parameters}}
41+
* @param { {{>type}} } {{#if default}}[{{/if}}params.{{{name}}}{{#if default}}={{default}}]{{/if}} {{#if description}}{{{escapeComment description}}}{{/if}}
42+
{{/each}}
43+
{{/if}}
44+
{{#each results}}
45+
* @returns {{{type}}} {{#if description}}{{{escapeComment description}}}{{/if}}
46+
{{/each}}
47+
* @throws ApiError
48+
*/
2849
{{name}}: ({{>parameters2}}) => Promise<Response<{{>result}}>>,
2950
{{/each}}
3051
},

src/templates/partials/parameters2.hbs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
11
{{#if parameters}}
2-
{{#if hasDefault}}
3-
{{#each parameters}}
4-
{{#if default}}
5-
// [params.{{{name}}}={{{default}}}]
6-
{{/if}}
7-
{{/each}}
8-
{{/if}}
92
params{{#if hasDefault}}?{{/if}}: {
103
{{#each parameters}}
114
{{{name}}}{{>isRequired}}: {{>type}},

0 commit comments

Comments
 (0)