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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
import type {
PropertySignature,
Type,
TypeParameterDeclaration,
} from 'ts-morph';
import { type JSDoc, type JSDocTag, type ParameterDeclaration } from 'ts-morph';
import { exactlyOne, valueForKey } from '../utils/value-checks';
import { newProcessingError } from './error';
import {
getDefault,
getDeprecated,
getDescription,
getJsDocs,
getParameterTags,
getTypeParameterTags,
} from './jsdocs';
import type { RawApiDocsType } from './type';
import { getNameSuffix, getTypeText, isOptionsLikeType } from './type';
/**
* Represents a parameter in the raw API docs.
*/
export interface RawApiDocsParameter {
/**
* The name of the parameter.
*/
name: string;
/**
* The type of the parameter.
*/
type: RawApiDocsType;
/**
* The default value or expression of the parameter, if it has one.
*/
default: string | undefined;
/**
* The description of the parameter.
*/
description: string;
}
export function processTypeParameters(
parameters: TypeParameterDeclaration[],
jsdocs: JSDoc
): RawApiDocsParameter[] {
const paramTags = getTypeParameterTags(jsdocs);
return parameters.flatMap((parameter) => {
try {
return processTypeParameterEntry(parameter, paramTags);
} catch (error) {
throw newProcessingError({
type: 'type parameter',
name: parameter.getName(),
source: parameter,
cause: error,
});
}
});
}
function processTypeParameterEntry(
parameter: TypeParameterDeclaration,
paramTags: Record<string, JSDocTag>
): RawApiDocsParameter {
return {
name: `<${parameter.getName()}>`,
type: getTypeText(parameter.getType(), { resolveAliases: true }),
default: parameter.getDefault()?.getText(),
description: getDescription(valueForKey(paramTags, parameter.getName())),
};
}
export function processParameters(
signatureParameters: ParameterDeclaration[],
implParameters: ParameterDeclaration[],
jsdocs: JSDoc
): RawApiDocsParameter[] {
const paramTags = getParameterTags(jsdocs);
const implParameterDefaults = Object.fromEntries(
implParameters.map((parameter) => [
parameter.getName(),
getDefaultValue(parameter),
])
);
return signatureParameters.flatMap((parameter) => {
try {
return processParameter(
parameter,
paramTags,
implParameterDefaults[parameter.getName()]
);
} catch (error) {
throw newProcessingError({
type: 'parameter',
name: parameter.getName(),
source: parameter,
cause: error,
});
}
});
}
function processParameter(
parameter: ParameterDeclaration,
paramTags: Record<string, JSDocTag>,
implementationDefault: string | undefined
): RawApiDocsParameter[] {
const name = parameter.getName();
return [
processSimpleParameter(
parameter,
valueForKey(paramTags, name),
implementationDefault
),
...processComplexParameter(name, parameter.getType()),
];
}
type ParameterLikeDeclaration = Pick<
ParameterDeclaration,
'getName' | 'getType'
> &
Partial<Pick<ParameterDeclaration, 'getInitializer'>>;
function processSimpleParameter(
parameter: ParameterLikeDeclaration,
jsdocTag: JSDocTag,
implementationDefault: string | undefined
): RawApiDocsParameter {
const name = parameter.getName();
const type = parameter.getType();
return {
name: `${name}${getNameSuffix(type)}`,
type: getTypeText(type, {
abbreviate: true,
stripUndefined: true,
}),
default: getDefaultValue(parameter) ?? implementationDefault,
description: getDescription(jsdocTag),
};
}
function getDefaultValue(
parameter: ParameterLikeDeclaration
): string | undefined {
return parameter
.getInitializer?.()
?.getText()
.replace(/ as .+$/, '');
}
function processComplexParameter(
name: string,
type: Type
): RawApiDocsParameter[] {
if (type.isNullable()) {
return processComplexParameter(name, type.getNonNullableType());
} else if (type.isUnion()) {
return type
.getUnionTypes()
.flatMap((unionType) => processComplexParameter(name, unionType));
} else if (type.isArray()) {
return processComplexParameter(
`${name}[]`,
type.getArrayElementTypeOrThrow()
);
} else if (type.isObject()) {
if (!isOptionsLikeType(type)) {
return [];
}
return type
.getApparentProperties()
.flatMap((parameter) => {
const declaration = exactlyOne(
parameter.getDeclarations(),
'property declaration'
) as PropertySignature;
const propertyType = declaration.getType();
const jsdocs = getJsDocs(declaration);
const deprecated = getDeprecated(jsdocs);
return [
{
name: `${name}.${parameter.getName()}${getNameSuffix(propertyType)}`,
type: getTypeText(propertyType, {
abbreviate: false,
stripUndefined: true,
}),
default: getDefault(jsdocs),
description:
getDescription(jsdocs) +
(deprecated ? `\n\n**DEPRECATED:** ${deprecated}` : ''),
},
];
})
.sort((a, b) => a.name.localeCompare(b.name));
}
return [];
}
|
