@@ -87,13 +87,15 @@ export type TypeDocOptionValues = {
87
87
* ```
88
88
*/
89
89
export interface TypeDocOptionMap {
90
+ // Configuration
90
91
options : string ;
91
92
tsconfig : string ;
92
93
compilerOptions : unknown ;
94
+ plugin : string [ ] ;
93
95
96
+ // Input
94
97
entryPoints : string [ ] ;
95
98
entryPointStrategy : typeof EntryPointStrategy ;
96
-
97
99
exclude : string [ ] ;
98
100
externalPattern : string [ ] ;
99
101
excludeExternals : boolean ;
@@ -103,80 +105,82 @@ export interface TypeDocOptionMap {
103
105
excludePrivate : boolean ;
104
106
excludeProtected : boolean ;
105
107
excludeReferences : boolean ;
106
- externalSymbolLinkMappings : ManuallyValidatedOption <
107
- Record < string , Record < string , string > >
108
- > ;
109
- media : string ;
110
- includes : string ;
108
+ name : string ;
109
+ includeVersion : boolean ;
110
+ disableSources : boolean ;
111
+ sourceLinkTemplate : string ;
112
+ gitRevision : string ;
113
+ gitRemote : string ;
114
+ readme : string ;
111
115
116
+ // Output
112
117
out : string ;
113
118
json : string ;
114
119
pretty : boolean ;
115
120
emit : typeof EmitStrategy ;
116
121
theme : string ;
117
-
118
122
lightHighlightTheme : ShikiTheme ;
119
123
darkHighlightTheme : ShikiTheme ;
120
124
customCss : string ;
121
125
markedOptions : unknown ;
122
- name : string ;
123
- includeVersion : boolean ;
124
- disableSources : boolean ;
125
126
basePath : string ;
126
- excludeTags : `@${string } `[ ] ;
127
- readme : string ;
128
127
cname : string ;
129
- sourceLinkTemplate : string ;
130
- gitRevision : string ;
131
- gitRemote : string ;
132
128
htmlLang : string ;
133
129
githubPages : boolean ;
130
+ cacheBust : boolean ;
134
131
gaID : string ;
135
132
hideGenerator : boolean ;
136
- cacheBust : boolean ;
137
133
searchInComments : boolean ;
138
134
cleanOutputDir : boolean ;
139
135
titleLink : string ;
140
136
navigationLinks : ManuallyValidatedOption < Record < string , string > > ;
141
137
sidebarLinks : ManuallyValidatedOption < Record < string , string > > ;
138
+ visibilityFilters : ManuallyValidatedOption < {
139
+ protected ?: boolean ;
140
+ private ?: boolean ;
141
+ inherited ?: boolean ;
142
+ external ?: boolean ;
143
+ [ tag : `@${string } `] : boolean ;
144
+ } > ;
145
+ searchCategoryBoosts : ManuallyValidatedOption < Record < string , number > > ;
146
+ searchGroupBoosts : ManuallyValidatedOption < Record < string , number > > ;
142
147
143
- jsDocCompatibility : JsDocCompatibility ;
148
+ // Comment
144
149
commentStyle : typeof CommentStyle ;
145
150
useTsLinkResolution : boolean ;
151
+ jsDocCompatibility : JsDocCompatibility ;
146
152
blockTags : `@${string } `[ ] ;
147
153
inlineTags : `@${string } `[ ] ;
148
154
modifierTags : `@${string } `[ ] ;
155
+ excludeTags : `@${string } `[ ] ;
156
+ externalSymbolLinkMappings : ManuallyValidatedOption <
157
+ Record < string , Record < string , string > >
158
+ > ;
159
+ media : string ;
160
+ includes : string ;
149
161
162
+ // Organization
150
163
categorizeByGroup : boolean ;
151
164
defaultCategory : string ;
152
165
categoryOrder : string [ ] ;
153
166
sort : SortStrategy [ ] ;
154
167
kindSortOrder : ReflectionKind . KindString [ ] ;
155
- visibilityFilters : ManuallyValidatedOption < {
156
- protected ?: boolean ;
157
- private ?: boolean ;
158
- inherited ?: boolean ;
159
- external ?: boolean ;
160
- [ tag : `@${string } `] : boolean ;
161
- } > ;
162
- searchCategoryBoosts : ManuallyValidatedOption < Record < string , number > > ;
163
- searchGroupBoosts : ManuallyValidatedOption < Record < string , number > > ;
164
-
165
- watch : boolean ;
166
- preserveWatchOutput : boolean ;
167
- skipErrorChecking : boolean ;
168
- help : boolean ;
169
- version : boolean ;
170
- showConfig : boolean ;
171
- plugin : string [ ] ;
172
- logLevel : typeof LogLevel ;
173
168
174
169
// Validation
175
170
treatWarningsAsErrors : boolean ;
176
171
treatValidationWarningsAsErrors : boolean ;
177
172
intentionallyNotExported : string [ ] ;
178
173
validation : ValidationOptions ;
179
174
requiredToBeDocumented : ReflectionKind . KindString [ ] ;
175
+
176
+ // Other
177
+ watch : boolean ;
178
+ preserveWatchOutput : boolean ;
179
+ help : boolean ;
180
+ version : boolean ;
181
+ showConfig : boolean ;
182
+ logLevel : typeof LogLevel ;
183
+ skipErrorChecking : boolean ;
180
184
}
181
185
182
186
/**
0 commit comments