/
option-types.ts
272 lines (242 loc) · 6.43 KB
/
option-types.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
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
// THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY.
import { ManuallyValidatedOption } from 'typedoc';
declare module 'typedoc' {
export interface TypeDocOptionMap {
anchorPrefix: string;
entryFileName: string;
entryModule: string;
enumMembersFormat: 'list' | 'table';
excludeGroups: boolean;
excludeScopesInPaths: boolean;
expandObjects: boolean;
expandParameters: boolean;
fileExtension: string;
flattenOutputFiles: boolean;
hideBreadcrumbs: boolean;
hidePageHeader: boolean;
hidePageTitle: boolean;
indexFormat: 'list' | 'table';
membersWithOwnFile: (
| 'Enum'
| 'Variable'
| 'Function'
| 'Class'
| 'Interface'
| 'TypeAlias'
)[];
mergeReadme: boolean;
navigationModel: {
excludeGroups: boolean;
excludeCategories: boolean;
excludeFolders: boolean;
};
outputFileStrategy: 'members' | 'modules';
parametersFormat: 'list' | 'table';
preserveAnchorCasing: boolean;
propertiesFormat: 'list' | 'table';
publicPath: string;
sanitizeComments: boolean;
textContentMappings: ManuallyValidatedOption<Partial<TextContentMappings>>;
typeDeclarationFormat: 'list' | 'table';
useCodeBlocks: boolean;
useHTMLAnchors: boolean;
}
}
/**
* Describes the options declared by the plugin.
*
* @category Options
*/
export interface PluginOptions {
/**
* Custom anchor prefix when anchoring to in-page symbols.
*/
anchorPrefix: string;
/**
* The file name of the entry page.
*/
entryFileName: string;
/**
* The name of a module that should act as the root page for the documentation.
*/
entryModule: string;
/**
* Specify the render style of enumeration members.
*/
enumMembersFormat: 'list' | 'table';
/**
* Excludes grouping by kind so all members are rendered and sorted at the same level.
*/
excludeGroups: boolean;
/**
* Exclude writing @ scope directories in paths.
*/
excludeScopesInPaths: boolean;
/**
* Expand objects inside declarations.
*/
expandObjects: boolean;
/**
* Expand parameters in signature parentheses to display type information.
*/
expandParameters: boolean;
/**
* Specify the file extension for generated output files.
*/
fileExtension: string;
/**
* Flatten output files to a single directory.
*/
flattenOutputFiles: boolean;
/**
* Do not print breadcrumbs.
*/
hideBreadcrumbs: boolean;
/**
* Do not print page header.
*/
hidePageHeader: boolean;
/**
* Do not print page title.
*/
hidePageTitle: boolean;
/**
* Specify the render format for index items.
*/
indexFormat: 'list' | 'table';
/**
* Determines which members are exported to their own file when `outputFileStrategy` equals `members`.
*/
membersWithOwnFile: (
| 'Enum'
| 'Variable'
| 'Function'
| 'Class'
| 'Interface'
| 'TypeAlias'
)[];
/**
* Merges the resolved readme into the project index page.
*/
mergeReadme: boolean;
/**
* Configures how the navigation model will be generated.
*/
navigationModel: {
excludeGroups: boolean;
excludeCategories: boolean;
excludeFolders: boolean;
};
/**
* Determines how output files are generated.
*/
outputFileStrategy: 'members' | 'modules';
/**
* Specify the render style of parameter and type parameter groups.
*/
parametersFormat: 'list' | 'table';
/**
* Preserve anchor casing when generating link to symbols.
*/
preserveAnchorCasing: boolean;
/**
* Specify the render style of property groups for interfaces and classes.
*/
propertiesFormat: 'list' | 'table';
/**
* Specify the base path for all urls.
*/
publicPath: string;
/**
* Sanitize HTML and JSX inside JsDoc comments.
*/
sanitizeComments: boolean;
/**
* Provides a mechanism to change the content of text used in documentation.
*/
textContentMappings: Partial<TextContentMappings>;
/**
* Specify the render style for type declaration members.
*/
typeDeclarationFormat: 'list' | 'table';
/**
* Wraps signatures and declarations in code blocks.
*/
useCodeBlocks: boolean;
/**
* Add HTML named anchors to headings and table rows.
*/
useHTMLAnchors: boolean;
}
/**
* Describes the keys available to replace static text.
*
* @category Options
*/
export interface TextContentMappings {
'header.title': string;
'header.docs': string;
'breadcrumbs.home': string;
'title.indexPage': string;
'title.modulePage': string;
'title.memberPage': string;
'label.apiIndex': string;
'label.defaultValue': string;
'label.description': string;
'label.extendedBy': string;
'label.extends': string;
'label.flags': string;
'label.globals': string;
'label.implements': string;
'label.implementationOf': string;
'label.inheritedFrom': string;
'label.index': string;
'label.indexable': string;
'label.indexSignature': string;
'label.member': string;
'label.modifier': string;
'label.name': string;
'label.overrides': string;
'label.packages': string;
'label.reExports': string;
'label.renamesAndReExports': string;
'label.returns': string;
'label.source': string;
'label.type': string;
'label.typeDeclaration': string;
'label.value': string;
'kind.accessor.singular': string;
'kind.accessor.plural': string;
'kind.class.singular': string;
'kind.class.plural': string;
'kind.constructor.singular': string;
'kind.constructor.plural': string;
'kind.enum.singular': string;
'kind.enum.plural': string;
'kind.enumMember.singular': string;
'kind.enumMember.plural': string;
'kind.event.singular': string;
'kind.event.plural': string;
'kind.function.singular': string;
'kind.function.plural': string;
'kind.interface.singular': string;
'kind.interface.plural': string;
'kind.method.singular': string;
'kind.method.plural': string;
'kind.module.singular': string;
'kind.module.plural': string;
'kind.namespace.singular': string;
'kind.namespace.plural': string;
'kind.variable.singular': string;
'kind.variable.plural': string;
'kind.parameter.singular': string;
'kind.parameter.plural': string;
'kind.property.singular': string;
'kind.property.plural': string;
'kind.reference.singular': string;
'kind.reference.plural': string;
'kind.typeAlias.singular': string;
'kind.typeAlias.plural': string;
'kind.typeParameter.singular': string;
'kind.typeParameter.plural': string;
}