Skip to content

Commit 36c52b8

Browse files
committed
fix(types): use Tuple<> format for tuples, preserve generics in references
1 parent db8f98f commit 36c52b8

File tree

9 files changed

+42
-31
lines changed

9 files changed

+42
-31
lines changed

package-lock.json

Lines changed: 17 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"prepare": "husky"
1111
},
1212
"dependencies": {
13-
"@node-core/doc-kit": "^1.0.1",
13+
"@node-core/doc-kit": "^1.2.0",
1414
"semver": "^7.7.4",
1515
"typedoc": "^0.28.17",
1616
"typedoc-plugin-markdown": "^4.10.0",

pages/v5.x/globals.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@ After this method has succeeded the cache can only be restored when build depend
612612
#### `getChunkEntryModulesWithChunkGroupIterable(chunk)`
613613

614614
* `chunk` {Chunk}
615-
* Returns: {Iterable<[Module, Entrypoint]>}
615+
* Returns: {Iterable<Tuple<Module, Entrypoint>>}
616616

617617
#### `getChunkFullHashModulesIterable(chunk)`
618618

@@ -4061,7 +4061,7 @@ and properties.
40614061

40624062
`R`
40634063
* `dependency` {D}
4064-
* `args` {[ARGS, unknown]}
4064+
* `args` {Tuple<ARGS, unknown>}
40654065
* Returns: {R}
40664066

40674067
#### `finishUpdateParent()`
@@ -5147,7 +5147,7 @@ Apply the plugin
51475147

51485148
#### `doResolve(hook, request, message, resolveContext, callback)`
51495149

5150-
* `hook` {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>}
5150+
* `hook` {AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest>}
51515151
* `request` {ResolveRequest}
51525152
* `message` {string}
51535153
* `resolveContext` {ResolveContext}
@@ -5156,13 +5156,13 @@ Apply the plugin
51565156

51575157
#### `ensureHook(name)`
51585158

5159-
* `name` {string|AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest, UnsetAdditionalOptions>}
5160-
* Returns: {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>}
5159+
* `name` {string|AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest, UnsetAdditionalOptions>}
5160+
* Returns: {AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest>}
51615161

51625162
#### `getHook(name)`
51635163

5164-
* `name` {string|AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest, UnsetAdditionalOptions>}
5165-
* Returns: {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>}
5164+
* `name` {string|AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest, UnsetAdditionalOptions>}
5165+
* Returns: {AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest>}
51665166

51675167
#### `isDirectory(path)`
51685168

@@ -5686,7 +5686,7 @@ Apply the plugin
56865686
#### Static method: `getModulesArrayBounds(modules)`
56875687

56885688
* `modules` {WithId[]}
5689-
* Returns: {false|[number, number]}
5689+
* Returns: {false|Tuple<number, number>}
56905690

56915691
#### Static method: `indent(s)`
56925692

@@ -7225,8 +7225,8 @@ Plugin instance.
72257225

72267226
> `const` **validateSchema**: {object}
72277227
7228-
* `schema` {Parameters<validateFunction>[0]}
7229-
* `options` {Parameters<validateFunction>[1]}
7228+
* `schema` {Parameters<validateFunction>}
7229+
* `options` {Parameters<validateFunction>}
72307230
* `validationConfiguration` {ValidationErrorConfiguration}
72317231
* Returns: {void}
72327232

pages/v5.x/webpack/namespaces/dependencies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#### `new ConstDependency(expression, range[, runtimeRequirements])`
1212

1313
* `expression` {string}
14-
* `range` {number|[number, number]}
14+
* `range` {number|Tuple<number, number>}
1515
* `runtimeRequirements` {string[]}
1616
* Returns: {ConstDependency}
1717

@@ -23,7 +23,7 @@
2323
* `loc` {DependencyLocation}
2424
* `module` {any}
2525
* `optional` {boolean}
26-
* `range` {number|[number, number]}
26+
* `range` {number|Tuple<number, number>}
2727
* `runtimeRequirements` {Set<string>}
2828
* `type` {string}
2929
* `weak` {boolean}
@@ -161,7 +161,7 @@ Update the hash
161161
* `module` {any}
162162
* `optional` {boolean}
163163
* `phase` {ImportPhaseType}
164-
* `range` {[number, number]}
164+
* `range` {Tuple<number, number>}
165165
* `request` {string}
166166
* `sourceOrder` {number}
167167
* `type` {string}
@@ -217,7 +217,7 @@ Returns the exported names
217217

218218
* `update` {boolean}
219219
* `__namedParameters` {DependencyTemplateContext}
220-
* Returns: {[string, string]}
220+
* Returns: {Tuple<string, string>}
221221

222222
#### `getImportVar(moduleGraph)`
223223

@@ -326,7 +326,7 @@ Update the hash
326326
* `loc` {DependencyLocation}
327327
* `module` {any}
328328
* `optional` {boolean}
329-
* `range` {[number, number]}
329+
* `range` {Tuple<number, number>}
330330
* `request` {string}
331331
* `sourceOrder` {number}
332332
* `type` {string}

pages/v5.x/webpack/namespaces/javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ Block pre walking iterates the scope for block variable declarations
291291

292292
#### `getComments(range)`
293293

294-
* `range` {[number, number]}
294+
* `range` {Tuple<number, number>}
295295
* Returns: {CommentJavascriptParser[]}
296296

297297
#### `getFreeInfoFromVariable(varName)`
@@ -413,7 +413,7 @@ Module pre walking iterates the scope for import entries
413413

414414
#### `parseCommentOptions(range)`
415415

416-
* `range` {[number, number]}
416+
* `range` {Tuple<number, number>}
417417
* Returns: {object}
418418

419419
#### `parseString(expression)`

pages/v5.x/webpack/namespaces/sources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -560,7 +560,7 @@
560560

561561
#### `getArgsAsBuffers()`
562562

563-
* Returns: {[Buffer<ArrayBufferLike>, string, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, boolean]}
563+
* Returns: {Tuple<Buffer<ArrayBufferLike>, string, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, boolean>}
564564

565565
#### `map([options])`
566566

pages/v5.x/webpack/namespaces/util/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
#### `entries()`
5858

59-
* Returns: {SetIterator<[T, T]>}
59+
* Returns: {SetIterator<Tuple<T, T>>}
6060

6161
#### `forEach(callbackFn, thisArg)`
6262

plugins/theme/partials/types.mjs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ const resolve = type => {
2323
return resolve(type.elementType) + '[]';
2424

2525
case 'tuple':
26-
return `[${(type.elements ?? []).map(resolve).join(', ')}]`;
26+
return `Tuple<${(type.elements ?? []).map(resolve).join(', ')}>`;
2727

2828
case 'union':
2929
case 'intersection':
3030
return union(type.types);
3131

3232
case 'optional':
33-
return resolve(type.elementType) + '?';
33+
return resolve(type.elementType);
3434

3535
case 'indexedAccess':
36-
return `${resolve(type.objectType)}[${resolve(type.indexType)}]`;
36+
return resolve(type.elementType ?? type.objectType);
3737

3838
case 'query':
3939
return resolve(type.queryType);
@@ -42,7 +42,7 @@ const resolve = type => {
4242
return resolve(type.target);
4343

4444
case 'conditional':
45-
return `${resolve(type.checkType)} extends ${resolve(type.extendsType)} ? ${resolve(type.trueType)} : ${resolve(type.falseType)}`;
45+
return `${resolve(type.trueType)}|${resolve(type.falseType)}`;
4646

4747
case 'named-tuple-member':
4848
return resolve(type.element);

plugins/theme/router.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import createNodeSlugger from '@node-core/doc-kit/src/utils/parser/slugger.mjs';
1+
import createNodeSlugger from '@node-core/doc-kit/src/generators/metadata/utils/slugger.mjs';
22
import { ModuleRouter } from 'typedoc-plugin-markdown';
33

44
const sluggers = new Map([]);

0 commit comments

Comments
 (0)