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
|
import type {
DeclarationReflection,
SignatureReflection,
TypeDocOptions,
} from 'typedoc';
import {
loadProject,
selectApiMethodSignatures,
selectApiModules,
} from '../../../scripts/apidoc/typedoc';
import { mapByName } from '../../../scripts/apidoc/utils';
/**
* Returns a record with the (Module-Name -> (Method-Name -> Method-Signature)) for the project.
*/
export function loadProjectModules(
options?: Partial<TypeDocOptions>,
includeTestModules = false
): Record<
string,
[DeclarationReflection, Record<string, SignatureReflection>]
> {
const [, project] = loadProject(options);
const modules = selectApiModules(project, includeTestModules);
return mapByName(modules, (m) => [m, selectApiMethodSignatures(m)]);
}
/**
* Loads the example methods using TypeDoc.
*/
export function loadExampleMethods(): Record<string, SignatureReflection> {
return loadProjectModules(
{
entryPoints: ['test/scripts/apidoc/signature.example.ts'],
tsconfig: 'test/scripts/apidoc/tsconfig.json',
},
true
)['SignatureTest'][1];
}
/**
* Loads the example modules using TypeDoc.
*/
export function loadExampleModules(): Record<string, DeclarationReflection> {
const modules = loadProjectModules(
{
entryPoints: ['test/scripts/apidoc/module.example.ts'],
tsconfig: 'test/scripts/apidoc/tsconfig.json',
},
true
);
const result: Record<string, DeclarationReflection> = {};
for (const key in modules) {
result[key] = modules[key][0];
}
return result;
}
|
