typedoc 0.26.11 → 0.27.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/package.json +3 -0
- package/bin/typedoc +1 -1
- package/dist/index.d.ts +23 -13
- package/dist/index.js +22 -81
- package/dist/lib/application-events.js +1 -4
- package/dist/lib/application.d.ts +26 -16
- package/dist/lib/application.js +222 -242
- package/dist/lib/cli.js +3 -40
- package/dist/lib/converter/comments/blockLexer.d.ts +1 -1
- package/dist/lib/converter/comments/blockLexer.js +24 -30
- package/dist/lib/converter/comments/declarationReference.js +10 -21
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +2 -2
- package/dist/lib/converter/comments/declarationReferenceResolver.js +40 -36
- package/dist/lib/converter/comments/discovery.d.ts +4 -4
- package/dist/lib/converter/comments/discovery.js +154 -172
- package/dist/lib/converter/comments/index.d.ts +4 -4
- package/dist/lib/converter/comments/index.js +39 -50
- package/dist/lib/converter/comments/lexer.d.ts +1 -1
- package/dist/lib/converter/comments/lexer.js +2 -5
- package/dist/lib/converter/comments/lineLexer.d.ts +1 -1
- package/dist/lib/converter/comments/lineLexer.js +12 -15
- package/dist/lib/converter/comments/linkResolver.d.ts +2 -2
- package/dist/lib/converter/comments/linkResolver.js +14 -21
- package/dist/lib/converter/comments/parser.d.ts +6 -6
- package/dist/lib/converter/comments/parser.js +69 -96
- package/dist/lib/converter/comments/rawLexer.d.ts +1 -1
- package/dist/lib/converter/comments/rawLexer.js +13 -16
- package/dist/lib/converter/comments/tagName.js +1 -4
- package/dist/lib/converter/comments/textParser.d.ts +4 -4
- package/dist/lib/converter/comments/textParser.js +28 -30
- package/dist/lib/converter/components.d.ts +2 -3
- package/dist/lib/converter/components.js +2 -7
- package/dist/lib/converter/context.d.ts +9 -9
- package/dist/lib/converter/context.js +54 -44
- package/dist/lib/converter/convert-expression.js +16 -23
- package/dist/lib/converter/converter-events.d.ts +1 -0
- package/dist/lib/converter/converter-events.js +2 -4
- package/dist/lib/converter/converter.d.ts +16 -13
- package/dist/lib/converter/converter.js +212 -239
- package/dist/lib/converter/factories/index-signature.d.ts +3 -3
- package/dist/lib/converter/factories/index-signature.js +43 -26
- package/dist/lib/converter/factories/signature.d.ts +2 -2
- package/dist/lib/converter/factories/signature.js +95 -106
- package/dist/lib/converter/index.d.ts +6 -7
- package/dist/lib/converter/index.js +3 -11
- package/dist/lib/converter/jsdoc.d.ts +1 -1
- package/dist/lib/converter/jsdoc.js +34 -41
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts +6 -21
- package/dist/lib/converter/plugins/CategoryPlugin.js +57 -139
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/CommentPlugin.js +153 -163
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +10 -9
- package/dist/lib/converter/plugins/GroupPlugin.js +87 -124
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/ImplementsPlugin.js +255 -321
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +11 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +72 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/InheritDocPlugin.js +41 -72
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +5 -5
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +37 -58
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts +12 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +49 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/PackagePlugin.js +62 -111
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/SourcePlugin.js +69 -110
- package/dist/lib/converter/plugins/TypePlugin.d.ts +4 -6
- package/dist/lib/converter/plugins/TypePlugin.js +95 -158
- package/dist/lib/converter/plugins/index.d.ts +10 -9
- package/dist/lib/converter/plugins/index.js +10 -21
- package/dist/lib/converter/symbols.d.ts +1 -1
- package/dist/lib/converter/symbols.js +234 -227
- package/dist/lib/converter/types.d.ts +2 -2
- package/dist/lib/converter/types.js +252 -237
- package/dist/lib/converter/utils/nodes.js +5 -13
- package/dist/lib/converter/utils/reflections.d.ts +1 -1
- package/dist/lib/converter/utils/reflections.js +4 -7
- package/dist/lib/converter/utils/repository.d.ts +1 -1
- package/dist/lib/converter/utils/repository.js +103 -97
- package/dist/lib/converter/utils/symbols.js +3 -9
- package/dist/lib/internationalization/index.d.ts +3 -4
- package/dist/lib/internationalization/index.js +3 -8
- package/dist/lib/internationalization/internationalization.d.ts +5 -4
- package/dist/lib/internationalization/internationalization.js +97 -103
- package/dist/lib/internationalization/locale-utils.cjs +8 -0
- package/dist/lib/internationalization/locale-utils.d.cts +8 -0
- package/dist/lib/internationalization/locales/en.cjs +372 -2
- package/dist/lib/internationalization/locales/en.d.cts +343 -2
- package/dist/lib/internationalization/locales/jp.cjs +13 -14
- package/dist/lib/internationalization/locales/jp.d.cts +307 -1
- package/dist/lib/internationalization/locales/ko.cjs +12 -11
- package/dist/lib/internationalization/locales/ko.d.cts +221 -1
- package/dist/lib/internationalization/locales/zh.cjs +43 -19
- package/dist/lib/internationalization/locales/zh.d.cts +409 -1
- package/dist/lib/internationalization/translatable.d.ts +4 -327
- package/dist/lib/internationalization/translatable.js +2 -360
- package/dist/lib/models/FileRegistry.d.ts +20 -9
- package/dist/lib/models/FileRegistry.js +54 -45
- package/dist/lib/models/ReflectionCategory.d.ts +2 -2
- package/dist/lib/models/ReflectionCategory.js +16 -12
- package/dist/lib/models/ReflectionGroup.d.ts +3 -3
- package/dist/lib/models/ReflectionGroup.js +23 -14
- package/dist/lib/models/comments/comment.d.ts +23 -37
- package/dist/lib/models/comments/comment.js +388 -325
- package/dist/lib/models/comments/index.d.ts +2 -2
- package/dist/lib/models/comments/index.js +1 -6
- package/dist/lib/models/index.d.ts +7 -7
- package/dist/lib/models/index.js +7 -23
- package/dist/lib/models/reflections/ReflectionSymbolId.d.ts +2 -2
- package/dist/lib/models/reflections/ReflectionSymbolId.js +42 -34
- package/dist/lib/models/reflections/abstract.d.ts +17 -20
- package/dist/lib/models/reflections/abstract.js +249 -256
- package/dist/lib/models/reflections/container.d.ts +7 -7
- package/dist/lib/models/reflections/container.js +43 -16
- package/dist/lib/models/reflections/declaration.d.ts +15 -12
- package/dist/lib/models/reflections/declaration.js +150 -29
- package/dist/lib/models/reflections/document.d.ts +3 -3
- package/dist/lib/models/reflections/document.js +26 -13
- package/dist/lib/models/reflections/index.d.ts +15 -15
- package/dist/lib/models/reflections/index.js +12 -31
- package/dist/lib/models/reflections/kind.d.ts +1 -1
- package/dist/lib/models/reflections/kind.js +3 -6
- package/dist/lib/models/reflections/parameter.d.ts +5 -4
- package/dist/lib/models/reflections/parameter.js +11 -13
- package/dist/lib/models/reflections/project.d.ts +14 -9
- package/dist/lib/models/reflections/project.js +104 -56
- package/dist/lib/models/reflections/reference.d.ts +3 -3
- package/dist/lib/models/reflections/reference.js +6 -9
- package/dist/lib/models/reflections/signature.d.ts +8 -8
- package/dist/lib/models/reflections/signature.js +35 -14
- package/dist/lib/models/reflections/type-parameter.d.ts +5 -5
- package/dist/lib/models/reflections/type-parameter.js +9 -10
- package/dist/lib/models/reflections/utils.js +1 -4
- package/dist/lib/models/reflections/variant.d.ts +8 -7
- package/dist/lib/models/reflections/variant.js +1 -2
- package/dist/lib/models/sources/file.d.ts +2 -2
- package/dist/lib/models/sources/file.js +22 -5
- package/dist/lib/models/sources/index.d.ts +1 -1
- package/dist/lib/models/sources/index.js +1 -5
- package/dist/lib/models/types.d.ts +29 -16
- package/dist/lib/models/types.js +236 -151
- package/dist/lib/output/components.d.ts +5 -11
- package/dist/lib/output/components.js +84 -125
- package/dist/lib/output/events.d.ts +3 -3
- package/dist/lib/output/events.js +128 -94
- package/dist/lib/output/formatter.d.ts +84 -0
- package/dist/lib/output/formatter.js +624 -0
- package/dist/lib/output/index.d.ts +9 -8
- package/dist/lib/output/index.js +7 -19
- package/dist/lib/output/models/UrlMapping.d.ts +2 -2
- package/dist/lib/output/models/UrlMapping.js +4 -5
- package/dist/lib/output/output.d.ts +14 -0
- package/dist/lib/output/output.js +91 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts +9 -8
- package/dist/lib/output/plugins/AssetsPlugin.js +64 -80
- package/dist/lib/output/plugins/HierarchyPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/HierarchyPlugin.js +67 -0
- package/dist/lib/output/plugins/IconsPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/IconsPlugin.js +28 -84
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts +9 -2
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +90 -96
- package/dist/lib/output/plugins/NavigationPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/NavigationPlugin.js +22 -102
- package/dist/lib/output/plugins/SitemapPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/SitemapPlugin.js +60 -120
- package/dist/lib/output/plugins/index.d.ts +7 -6
- package/dist/lib/output/plugins/index.js +7 -15
- package/dist/lib/output/renderer.d.ts +14 -13
- package/dist/lib/output/renderer.js +130 -185
- package/dist/lib/output/theme.d.ts +9 -5
- package/dist/lib/output/theme.js +14 -62
- package/dist/lib/output/themes/MarkedPlugin.d.ts +8 -9
- package/dist/lib/output/themes/MarkedPlugin.js +152 -117
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +17 -29
- package/dist/lib/output/themes/default/DefaultTheme.js +334 -310
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +63 -48
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +119 -95
- package/dist/lib/output/themes/default/Slugger.d.ts +13 -0
- package/dist/lib/output/themes/default/Slugger.js +46 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +5 -5
- package/dist/lib/output/themes/default/layouts/default.js +48 -36
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/anchor-icon.js +4 -7
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/breadcrumb.js +4 -8
- package/dist/lib/output/themes/default/partials/comment.d.ts +6 -4
- package/dist/lib/output/themes/default/partials/comment.js +52 -29
- package/dist/lib/output/themes/default/partials/footer.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/footer.js +11 -14
- package/dist/lib/output/themes/default/partials/header.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/header.js +9 -13
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/hierarchy.js +12 -15
- package/dist/lib/output/themes/default/partials/icon.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/icon.js +78 -73
- package/dist/lib/output/themes/default/partials/index.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/index.js +19 -22
- package/dist/lib/output/themes/default/partials/member.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.js +18 -61
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +10 -26
- package/dist/lib/output/themes/default/partials/member.js +19 -24
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signature.body.js +17 -21
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +4 -7
- package/dist/lib/output/themes/default/partials/member.signature.title.js +8 -35
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signatures.js +9 -13
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.sources.js +13 -17
- package/dist/lib/output/themes/default/partials/members.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/members.js +10 -42
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +62 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/navigation.js +51 -62
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +12 -15
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/toolbar.js +16 -20
- package/dist/lib/output/themes/default/partials/type.d.ts +4 -6
- package/dist/lib/output/themes/default/partials/type.js +8 -388
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeAndParent.js +11 -15
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +222 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeParameters.js +14 -17
- package/dist/lib/output/themes/default/templates/document.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/document.js +3 -7
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/hierarchy.js +24 -22
- package/dist/lib/output/themes/default/templates/index.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/index.js +3 -7
- package/dist/lib/output/themes/default/templates/reflection.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/reflection.js +32 -34
- package/dist/lib/output/themes/lib.d.ts +17 -3
- package/dist/lib/output/themes/lib.js +118 -50
- package/dist/lib/serialization/components.d.ts +2 -5
- package/dist/lib/serialization/components.js +1 -2
- package/dist/lib/serialization/deserializer.d.ts +21 -7
- package/dist/lib/serialization/deserializer.js +138 -123
- package/dist/lib/serialization/events.d.ts +2 -2
- package/dist/lib/serialization/events.js +6 -5
- package/dist/lib/serialization/index.d.ts +5 -5
- package/dist/lib/serialization/index.js +4 -33
- package/dist/lib/serialization/schema.d.ts +8 -2
- package/dist/lib/serialization/schema.js +2 -2
- package/dist/lib/serialization/serializer.d.ts +11 -5
- package/dist/lib/serialization/serializer.js +32 -25
- package/dist/lib/utils/array.d.ts +3 -0
- package/dist/lib/utils/array.js +26 -27
- package/dist/lib/utils/component.d.ts +2 -44
- package/dist/lib/utils/component.js +10 -102
- package/dist/lib/utils/entry-point.d.ts +3 -4
- package/dist/lib/utils/entry-point.js +114 -85
- package/dist/lib/utils/enum.js +6 -14
- package/dist/lib/utils/events.js +6 -12
- package/dist/lib/utils/fs.js +50 -91
- package/dist/lib/utils/general.d.ts +2 -1
- package/dist/lib/utils/general.js +50 -40
- package/dist/lib/utils/highlighter.js +30 -57
- package/dist/lib/utils/hooks.js +7 -13
- package/dist/lib/utils/html-entities.d.ts +8926 -0
- package/dist/lib/utils/html-entities.js +2329 -0
- package/dist/lib/utils/html.d.ts +8 -0
- package/dist/lib/utils/html.js +81 -34
- package/dist/lib/utils/index.d.ts +22 -22
- package/dist/lib/utils/index.js +20 -91
- package/dist/lib/utils/jsx.d.ts +12 -6
- package/dist/lib/utils/jsx.elements.d.ts +1 -1
- package/dist/lib/utils/jsx.elements.js +3 -4
- package/dist/lib/utils/jsx.js +82 -52
- package/dist/lib/utils/loggers.d.ts +3 -3
- package/dist/lib/utils/loggers.js +36 -46
- package/dist/lib/utils/map.js +6 -13
- package/dist/lib/utils/minimalSourceFile.js +5 -7
- package/dist/lib/utils/options/declaration.d.ts +35 -7
- package/dist/lib/utils/options/declaration.js +20 -22
- package/dist/lib/utils/options/defaults.d.ts +3 -2
- package/dist/lib/utils/options/defaults.js +18 -38
- package/dist/lib/utils/options/help.d.ts +2 -2
- package/dist/lib/utils/options/help.js +7 -10
- package/dist/lib/utils/options/index.d.ts +6 -6
- package/dist/lib/utils/options/index.js +4 -18
- package/dist/lib/utils/options/options.d.ts +8 -5
- package/dist/lib/utils/options/options.js +47 -71
- package/dist/lib/utils/options/readers/arguments.d.ts +2 -2
- package/dist/lib/utils/options/readers/arguments.js +15 -17
- package/dist/lib/utils/options/readers/index.d.ts +4 -4
- package/dist/lib/utils/options/readers/index.js +4 -11
- package/dist/lib/utils/options/readers/package-json.d.ts +3 -3
- package/dist/lib/utils/options/readers/package-json.js +15 -21
- package/dist/lib/utils/options/readers/tsconfig.d.ts +2 -2
- package/dist/lib/utils/options/readers/tsconfig.js +54 -63
- package/dist/lib/utils/options/readers/typedoc.d.ts +3 -3
- package/dist/lib/utils/options/readers/typedoc.js +44 -76
- package/dist/lib/utils/options/sources/index.d.ts +1 -1
- package/dist/lib/utils/options/sources/index.js +1 -5
- package/dist/lib/utils/options/sources/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/sources/typedoc.js +232 -196
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +3 -3
- package/dist/lib/utils/options/tsdoc-defaults.js +16 -12
- package/dist/lib/utils/package-manifest.d.ts +1 -1
- package/dist/lib/utils/package-manifest.js +15 -19
- package/dist/lib/utils/paths.js +9 -15
- package/dist/lib/utils/perf.js +6 -11
- package/dist/lib/utils/plugins.d.ts +1 -1
- package/dist/lib/utils/plugins.js +7 -10
- package/dist/lib/utils/reflections.d.ts +1 -1
- package/dist/lib/utils/reflections.js +9 -12
- package/dist/lib/utils/set.js +2 -6
- package/dist/lib/utils/sort.d.ts +3 -3
- package/dist/lib/utils/sort.js +20 -24
- package/dist/lib/utils/tsconfig.d.ts +1 -1
- package/dist/lib/utils/tsconfig.js +13 -21
- package/dist/lib/utils/tsutils.d.ts +1 -1
- package/dist/lib/utils/tsutils.js +3 -30
- package/dist/lib/utils/validation.js +6 -12
- package/dist/lib/validation/documentation.d.ts +2 -2
- package/dist/lib/validation/documentation.js +26 -29
- package/dist/lib/validation/exports.d.ts +2 -2
- package/dist/lib/validation/exports.js +9 -11
- package/dist/lib/validation/links.d.ts +2 -2
- package/dist/lib/validation/links.js +4 -7
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +3 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +11 -0
- package/package.json +17 -14
- package/static/main.js +4 -4
- package/static/style.css +109 -17
- package/tsdoc.json +30 -0
- package/dist/lib/output/themes/default/partials/member.reference.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/member.reference.js +0 -30
- package/dist/lib/output/themes/default/partials/parameter.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/parameter.js +0 -79
- package/dist/lib/utils/html-entities.json +0 -2326
|
@@ -1,14 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
const ReflectionCategory_1 = require("../ReflectionCategory");
|
|
6
|
-
const ReflectionGroup_1 = require("../ReflectionGroup");
|
|
7
|
-
const utils_1 = require("../../utils");
|
|
1
|
+
import { Reflection, TraverseProperty, } from "./abstract.js";
|
|
2
|
+
import { ReflectionCategory } from "../ReflectionCategory.js";
|
|
3
|
+
import { ReflectionGroup } from "../ReflectionGroup.js";
|
|
4
|
+
import { removeIfPresent } from "../../utils/index.js";
|
|
8
5
|
/**
|
|
9
6
|
* @category Reflections
|
|
10
7
|
*/
|
|
11
|
-
class ContainerReflection extends
|
|
8
|
+
export class ContainerReflection extends Reflection {
|
|
9
|
+
/**
|
|
10
|
+
* The children of this reflection. Do not add reflections to this array
|
|
11
|
+
* manually. Instead call {@link addChild}.
|
|
12
|
+
*/
|
|
13
|
+
children;
|
|
14
|
+
/**
|
|
15
|
+
* Documents associated with this reflection.
|
|
16
|
+
*
|
|
17
|
+
* These are not children as including them as children requires code handle both
|
|
18
|
+
* types, despite being mostly unrelated and handled separately.
|
|
19
|
+
*
|
|
20
|
+
* Including them here in a separate array neatly handles that problem, but also
|
|
21
|
+
* introduces another one for rendering. When rendering, documents should really
|
|
22
|
+
* actually be considered part of the "children" of a reflection. For this reason,
|
|
23
|
+
* we also maintain a list of child declarations with child documents which is used
|
|
24
|
+
* when rendering.
|
|
25
|
+
*/
|
|
26
|
+
documents;
|
|
27
|
+
/**
|
|
28
|
+
* Union of the {@link children} and {@link documents} arrays which dictates the
|
|
29
|
+
* sort order for rendering.
|
|
30
|
+
*/
|
|
31
|
+
childrenIncludingDocuments;
|
|
32
|
+
/**
|
|
33
|
+
* All children grouped by their kind.
|
|
34
|
+
*/
|
|
35
|
+
groups;
|
|
36
|
+
/**
|
|
37
|
+
* All children grouped by their category.
|
|
38
|
+
*/
|
|
39
|
+
categories;
|
|
12
40
|
/**
|
|
13
41
|
* Return a list of all children of a certain kind.
|
|
14
42
|
*
|
|
@@ -32,30 +60,30 @@ class ContainerReflection extends abstract_1.Reflection {
|
|
|
32
60
|
}
|
|
33
61
|
removeChild(child) {
|
|
34
62
|
if (child.isDeclaration()) {
|
|
35
|
-
|
|
63
|
+
removeIfPresent(this.children, child);
|
|
36
64
|
if (this.children?.length === 0) {
|
|
37
65
|
delete this.children;
|
|
38
66
|
}
|
|
39
67
|
}
|
|
40
68
|
else {
|
|
41
|
-
|
|
69
|
+
removeIfPresent(this.documents, child);
|
|
42
70
|
if (this.documents?.length === 0) {
|
|
43
71
|
delete this.documents;
|
|
44
72
|
}
|
|
45
73
|
}
|
|
46
|
-
|
|
74
|
+
removeIfPresent(this.childrenIncludingDocuments, child);
|
|
47
75
|
if (this.childrenIncludingDocuments?.length === 0) {
|
|
48
76
|
delete this.childrenIncludingDocuments;
|
|
49
77
|
}
|
|
50
78
|
}
|
|
51
79
|
traverse(callback) {
|
|
52
80
|
for (const child of this.children?.slice() || []) {
|
|
53
|
-
if (callback(child,
|
|
81
|
+
if (callback(child, TraverseProperty.Children) === false) {
|
|
54
82
|
return;
|
|
55
83
|
}
|
|
56
84
|
}
|
|
57
85
|
for (const child of this.documents?.slice() || []) {
|
|
58
|
-
if (callback(child,
|
|
86
|
+
if (callback(child, TraverseProperty.Documents) === false) {
|
|
59
87
|
return;
|
|
60
88
|
}
|
|
61
89
|
}
|
|
@@ -99,8 +127,7 @@ class ContainerReflection extends abstract_1.Reflection {
|
|
|
99
127
|
this.childrenIncludingDocuments ||= [];
|
|
100
128
|
this.childrenIncludingDocuments.push(...byId.values());
|
|
101
129
|
}
|
|
102
|
-
this.groups = de.reviveMany(obj.groups, (group) => new
|
|
103
|
-
this.categories = de.reviveMany(obj.categories, (cat) => new
|
|
130
|
+
this.groups = de.reviveMany(obj.groups, (group) => new ReflectionGroup(group.title, this));
|
|
131
|
+
this.categories = de.reviveMany(obj.categories, (cat) => new ReflectionCategory(cat.title));
|
|
104
132
|
}
|
|
105
133
|
}
|
|
106
|
-
exports.ContainerReflection = ContainerReflection;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type * as ts from "typescript";
|
|
2
|
-
import { type ReferenceType, type
|
|
3
|
-
import { type TraverseCallback } from "./abstract";
|
|
4
|
-
import { ContainerReflection } from "./container";
|
|
5
|
-
import type { SignatureReflection } from "./signature";
|
|
6
|
-
import type { TypeParameterReflection } from "./type-parameter";
|
|
7
|
-
import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
|
|
8
|
-
import { type CommentDisplayPart } from "../comments";
|
|
9
|
-
import { SourceReference } from "../sources/file";
|
|
2
|
+
import { type ReferenceType, type SomeType } from "../types.js";
|
|
3
|
+
import { type TraverseCallback } from "./abstract.js";
|
|
4
|
+
import { ContainerReflection } from "./container.js";
|
|
5
|
+
import type { SignatureReflection } from "./signature.js";
|
|
6
|
+
import type { TypeParameterReflection } from "./type-parameter.js";
|
|
7
|
+
import type { Serializer, JSONOutput, Deserializer } from "../../serialization/index.js";
|
|
8
|
+
import { type CommentDisplayPart } from "../comments/index.js";
|
|
9
|
+
import { SourceReference } from "../sources/file.js";
|
|
10
10
|
/**
|
|
11
11
|
* Stores hierarchical type data.
|
|
12
12
|
*
|
|
@@ -16,7 +16,7 @@ export interface DeclarationHierarchy {
|
|
|
16
16
|
/**
|
|
17
17
|
* The types represented by this node in the hierarchy.
|
|
18
18
|
*/
|
|
19
|
-
types:
|
|
19
|
+
types: SomeType[];
|
|
20
20
|
/**
|
|
21
21
|
* The next hierarchy level.
|
|
22
22
|
*/
|
|
@@ -40,8 +40,10 @@ export declare class DeclarationReflection extends ContainerReflection {
|
|
|
40
40
|
*/
|
|
41
41
|
sources?: SourceReference[];
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
44
|
-
*
|
|
43
|
+
* Precomputed boost for search results, may be less than 1 to de-emphasize this member in search results.
|
|
44
|
+
* Does NOT include group/category values as they are computed when building the JS index.
|
|
45
|
+
*
|
|
46
|
+
* This is preserved for plugins, and may be removed in 0.28 if no plugins have used it yet.
|
|
45
47
|
*/
|
|
46
48
|
relevanceBoost?: number;
|
|
47
49
|
/**
|
|
@@ -135,8 +137,9 @@ export declare class DeclarationReflection extends ContainerReflection {
|
|
|
135
137
|
isDeclaration(): this is DeclarationReflection;
|
|
136
138
|
hasGetterOrSetter(): boolean;
|
|
137
139
|
getAllSignatures(): SignatureReflection[];
|
|
138
|
-
/** @internal */
|
|
139
140
|
getNonIndexSignatures(): SignatureReflection[];
|
|
141
|
+
getProperties(): DeclarationReflection[];
|
|
142
|
+
getChildOrTypePropertyByName(path: string[]): DeclarationReflection | undefined;
|
|
140
143
|
traverse(callback: TraverseCallback): void;
|
|
141
144
|
/**
|
|
142
145
|
* Return a string representation of this reflection.
|
|
@@ -1,13 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
const file_1 = require("../sources/file");
|
|
9
|
-
const ReflectionSymbolId_1 = require("./ReflectionSymbolId");
|
|
10
|
-
const kind_1 = require("./kind");
|
|
1
|
+
import { ReflectionType } from "../types.js";
|
|
2
|
+
import { TraverseProperty } from "./abstract.js";
|
|
3
|
+
import { ContainerReflection } from "./container.js";
|
|
4
|
+
import { Comment } from "../comments/index.js";
|
|
5
|
+
import { SourceReference } from "../sources/file.js";
|
|
6
|
+
import { ReflectionSymbolId } from "./ReflectionSymbolId.js";
|
|
7
|
+
import { ReflectionKind } from "./kind.js";
|
|
11
8
|
/**
|
|
12
9
|
* A reflection that represents a single declaration emitted by the TypeScript compiler.
|
|
13
10
|
*
|
|
@@ -15,11 +12,107 @@ const kind_1 = require("./kind");
|
|
|
15
12
|
* kind of a reflection is stored in its ´kind´ member.
|
|
16
13
|
* @category Reflections
|
|
17
14
|
*/
|
|
18
|
-
class DeclarationReflection extends
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
15
|
+
export class DeclarationReflection extends ContainerReflection {
|
|
16
|
+
variant = "declaration";
|
|
17
|
+
/**
|
|
18
|
+
* A list of all source files that contributed to this reflection.
|
|
19
|
+
*/
|
|
20
|
+
sources;
|
|
21
|
+
/**
|
|
22
|
+
* Precomputed boost for search results, may be less than 1 to de-emphasize this member in search results.
|
|
23
|
+
* Does NOT include group/category values as they are computed when building the JS index.
|
|
24
|
+
*
|
|
25
|
+
* This is preserved for plugins, and may be removed in 0.28 if no plugins have used it yet.
|
|
26
|
+
*/
|
|
27
|
+
relevanceBoost;
|
|
28
|
+
/**
|
|
29
|
+
* The escaped name of this declaration assigned by the TS compiler if there is an associated symbol.
|
|
30
|
+
* This is used to retrieve properties for analyzing inherited members.
|
|
31
|
+
*
|
|
32
|
+
* Not serialized, only useful during conversion.
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
escapedName;
|
|
36
|
+
/**
|
|
37
|
+
* The type of the reflection.
|
|
38
|
+
*
|
|
39
|
+
* If the reflection represents a variable or a property, this is the value type.<br />
|
|
40
|
+
* If the reflection represents a signature, this is the return type.
|
|
41
|
+
*/
|
|
42
|
+
type;
|
|
43
|
+
typeParameters;
|
|
44
|
+
/**
|
|
45
|
+
* A list of call signatures attached to this declaration.
|
|
46
|
+
*
|
|
47
|
+
* TypeDoc creates one declaration per function that may contain one or more
|
|
48
|
+
* signature reflections.
|
|
49
|
+
*/
|
|
50
|
+
signatures;
|
|
51
|
+
/**
|
|
52
|
+
* The index signature of this declaration.
|
|
53
|
+
*/
|
|
54
|
+
indexSignatures;
|
|
55
|
+
/**
|
|
56
|
+
* The get signature of this declaration.
|
|
57
|
+
*/
|
|
58
|
+
getSignature;
|
|
59
|
+
/**
|
|
60
|
+
* The set signature of this declaration.
|
|
61
|
+
*/
|
|
62
|
+
setSignature;
|
|
63
|
+
/**
|
|
64
|
+
* The default value of this reflection.
|
|
65
|
+
*
|
|
66
|
+
* Applies to function parameters, variables, and properties.
|
|
67
|
+
*/
|
|
68
|
+
defaultValue;
|
|
69
|
+
/**
|
|
70
|
+
* A type that points to the reflection that has been overwritten by this reflection.
|
|
71
|
+
*
|
|
72
|
+
* Applies to interface and class members.
|
|
73
|
+
*/
|
|
74
|
+
overwrites;
|
|
75
|
+
/**
|
|
76
|
+
* A type that points to the reflection this reflection has been inherited from.
|
|
77
|
+
*
|
|
78
|
+
* Applies to interface and class members.
|
|
79
|
+
*/
|
|
80
|
+
inheritedFrom;
|
|
81
|
+
/**
|
|
82
|
+
* A type that points to the reflection this reflection is the implementation of.
|
|
83
|
+
*
|
|
84
|
+
* Applies to class members.
|
|
85
|
+
*/
|
|
86
|
+
implementationOf;
|
|
87
|
+
/**
|
|
88
|
+
* A list of all types this reflection extends (e.g. the parent classes).
|
|
89
|
+
*/
|
|
90
|
+
extendedTypes;
|
|
91
|
+
/**
|
|
92
|
+
* A list of all types that extend this reflection (e.g. the subclasses).
|
|
93
|
+
*/
|
|
94
|
+
extendedBy;
|
|
95
|
+
/**
|
|
96
|
+
* A list of all types this reflection implements.
|
|
97
|
+
*/
|
|
98
|
+
implementedTypes;
|
|
99
|
+
/**
|
|
100
|
+
* A list of all types that implement this reflection.
|
|
101
|
+
*/
|
|
102
|
+
implementedBy;
|
|
103
|
+
/**
|
|
104
|
+
* Contains a simplified representation of the type hierarchy suitable for being
|
|
105
|
+
* rendered in templates.
|
|
106
|
+
*/
|
|
107
|
+
typeHierarchy;
|
|
108
|
+
/**
|
|
109
|
+
* The contents of the readme file of the module when found.
|
|
110
|
+
*/
|
|
111
|
+
readme;
|
|
112
|
+
/**
|
|
113
|
+
* The version of the module when found.
|
|
114
|
+
*/
|
|
115
|
+
packageVersion;
|
|
23
116
|
isDeclaration() {
|
|
24
117
|
return true;
|
|
25
118
|
}
|
|
@@ -42,39 +135,68 @@ class DeclarationReflection extends container_1.ContainerReflection {
|
|
|
42
135
|
}
|
|
43
136
|
return result;
|
|
44
137
|
}
|
|
45
|
-
/** @internal */
|
|
46
138
|
getNonIndexSignatures() {
|
|
47
139
|
return [].concat(this.signatures ?? [], this.setSignature ?? [], this.getSignature ?? []);
|
|
48
140
|
}
|
|
141
|
+
getProperties() {
|
|
142
|
+
if (this.children?.length) {
|
|
143
|
+
return this.children;
|
|
144
|
+
}
|
|
145
|
+
if (this.type?.type === "reflection") {
|
|
146
|
+
return this.type.declaration.children ?? [];
|
|
147
|
+
}
|
|
148
|
+
return [];
|
|
149
|
+
}
|
|
150
|
+
getChildOrTypePropertyByName(path) {
|
|
151
|
+
if (this.type?.type === "reflection") {
|
|
152
|
+
for (const child of this.type.declaration.children || []) {
|
|
153
|
+
if (path[0] === child.name) {
|
|
154
|
+
if (path.length === 1) {
|
|
155
|
+
return child;
|
|
156
|
+
}
|
|
157
|
+
return child.getChildOrTypePropertyByName(path.slice(1));
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
for (const child of this.children || []) {
|
|
162
|
+
if (path[0] === child.name) {
|
|
163
|
+
if (path.length === 1) {
|
|
164
|
+
return child;
|
|
165
|
+
}
|
|
166
|
+
return child.getChildOrTypePropertyByName(path.slice(1));
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
return undefined;
|
|
170
|
+
}
|
|
49
171
|
traverse(callback) {
|
|
50
172
|
for (const parameter of this.typeParameters?.slice() || []) {
|
|
51
|
-
if (callback(parameter,
|
|
173
|
+
if (callback(parameter, TraverseProperty.TypeParameter) === false) {
|
|
52
174
|
return;
|
|
53
175
|
}
|
|
54
176
|
}
|
|
55
|
-
if (this.type instanceof
|
|
56
|
-
if (callback(this.type.declaration,
|
|
177
|
+
if (this.type instanceof ReflectionType) {
|
|
178
|
+
if (callback(this.type.declaration, TraverseProperty.TypeLiteral) === false) {
|
|
57
179
|
return;
|
|
58
180
|
}
|
|
59
181
|
}
|
|
60
182
|
for (const signature of this.signatures?.slice() || []) {
|
|
61
|
-
if (callback(signature,
|
|
183
|
+
if (callback(signature, TraverseProperty.Signatures) === false) {
|
|
62
184
|
return;
|
|
63
185
|
}
|
|
64
186
|
}
|
|
65
187
|
for (const signature of this.indexSignatures?.slice() || []) {
|
|
66
|
-
if (callback(signature,
|
|
188
|
+
if (callback(signature, TraverseProperty.IndexSignature) === false) {
|
|
67
189
|
return;
|
|
68
190
|
}
|
|
69
191
|
}
|
|
70
192
|
if (this.getSignature) {
|
|
71
|
-
if (callback(this.getSignature,
|
|
193
|
+
if (callback(this.getSignature, TraverseProperty.GetSignature) ===
|
|
72
194
|
false) {
|
|
73
195
|
return;
|
|
74
196
|
}
|
|
75
197
|
}
|
|
76
198
|
if (this.setSignature) {
|
|
77
|
-
if (callback(this.setSignature,
|
|
199
|
+
if (callback(this.setSignature, TraverseProperty.SetSignature) ===
|
|
78
200
|
false) {
|
|
79
201
|
return;
|
|
80
202
|
}
|
|
@@ -116,25 +238,25 @@ class DeclarationReflection extends container_1.ContainerReflection {
|
|
|
116
238
|
extendedBy: serializer.toObjectsOptional(this.extendedBy),
|
|
117
239
|
implementedTypes: serializer.toObjectsOptional(this.implementedTypes),
|
|
118
240
|
implementedBy: serializer.toObjectsOptional(this.implementedBy),
|
|
119
|
-
readme:
|
|
241
|
+
readme: Comment.serializeDisplayParts(serializer, this.readme),
|
|
120
242
|
};
|
|
121
243
|
}
|
|
122
244
|
fromObject(de, obj) {
|
|
123
245
|
super.fromObject(de, obj);
|
|
124
246
|
if (obj.readme) {
|
|
125
|
-
this.readme =
|
|
247
|
+
this.readme = Comment.deserializeDisplayParts(de, obj.readme);
|
|
126
248
|
}
|
|
127
249
|
// This happens when merging multiple projects together.
|
|
128
250
|
// If updating this, also check ProjectReflection.fromObject.
|
|
129
251
|
if (obj.variant === "project") {
|
|
130
|
-
this.kind =
|
|
252
|
+
this.kind = ReflectionKind.Module;
|
|
131
253
|
this.packageVersion = obj.packageVersion;
|
|
132
254
|
this.project.files.fromObject(de, obj.files || {});
|
|
133
255
|
de.defer(() => {
|
|
134
256
|
for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
|
|
135
257
|
const refl = this.project.getReflectionById(de.oldIdToNewId[+id] ?? -1);
|
|
136
258
|
if (refl) {
|
|
137
|
-
this.project.registerSymbolId(refl, new
|
|
259
|
+
this.project.registerSymbolId(refl, new ReflectionSymbolId(sid));
|
|
138
260
|
}
|
|
139
261
|
else {
|
|
140
262
|
de.logger.warn(de.application.i18n.serialized_project_referenced_0_not_part_of_project(id.toString()));
|
|
@@ -144,7 +266,7 @@ class DeclarationReflection extends container_1.ContainerReflection {
|
|
|
144
266
|
return;
|
|
145
267
|
}
|
|
146
268
|
this.packageVersion = obj.packageVersion;
|
|
147
|
-
this.sources = de.reviveMany(obj.sources, (src) => new
|
|
269
|
+
this.sources = de.reviveMany(obj.sources, (src) => new SourceReference(src.fileName, src.line, src.character));
|
|
148
270
|
this.relevanceBoost = obj.relevanceBoost;
|
|
149
271
|
this.typeParameters = de.reviveMany(obj.typeParameters, (tp) => de.constructReflection(tp));
|
|
150
272
|
this.type = de.revive(obj.type, (t) => de.constructType(t));
|
|
@@ -172,4 +294,3 @@ class DeclarationReflection extends container_1.ContainerReflection {
|
|
|
172
294
|
this.implementedBy = de.reviveMany(obj.implementedBy, (t) => de.reviveType(t));
|
|
173
295
|
}
|
|
174
296
|
}
|
|
175
|
-
exports.DeclarationReflection = DeclarationReflection;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { Deserializer, JSONOutput, Serializer } from "../../serialization";
|
|
2
|
-
import { type CommentDisplayPart } from "../comments";
|
|
3
|
-
import { Reflection, type TraverseCallback } from "./abstract";
|
|
1
|
+
import type { Deserializer, JSONOutput, Serializer } from "../../serialization/index.js";
|
|
2
|
+
import { type CommentDisplayPart } from "../comments/index.js";
|
|
3
|
+
import { Reflection, type TraverseCallback } from "./abstract.js";
|
|
4
4
|
/**
|
|
5
5
|
* Non-TS reflection type which is used to represent markdown documents included in the docs.
|
|
6
6
|
*/
|
|
@@ -1,16 +1,30 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
const comments_1 = require("../comments");
|
|
5
|
-
const abstract_1 = require("./abstract");
|
|
6
|
-
const kind_1 = require("./kind");
|
|
1
|
+
import { Comment } from "../comments/index.js";
|
|
2
|
+
import { Reflection, TraverseProperty, } from "./abstract.js";
|
|
3
|
+
import { ReflectionKind } from "./kind.js";
|
|
7
4
|
/**
|
|
8
5
|
* Non-TS reflection type which is used to represent markdown documents included in the docs.
|
|
9
6
|
*/
|
|
10
|
-
class DocumentReflection extends
|
|
7
|
+
export class DocumentReflection extends Reflection {
|
|
8
|
+
variant = "document";
|
|
9
|
+
/**
|
|
10
|
+
* The content to be displayed on the page for this reflection.
|
|
11
|
+
*/
|
|
12
|
+
content;
|
|
13
|
+
/**
|
|
14
|
+
* Frontmatter included in document
|
|
15
|
+
*/
|
|
16
|
+
frontmatter;
|
|
17
|
+
/**
|
|
18
|
+
* A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when
|
|
19
|
+
* boosting search relevance scores at runtime. May be modified by plugins.
|
|
20
|
+
*/
|
|
21
|
+
relevanceBoost;
|
|
22
|
+
/**
|
|
23
|
+
* Child documents, if any are present.
|
|
24
|
+
*/
|
|
25
|
+
children;
|
|
11
26
|
constructor(name, parent, content, frontmatter) {
|
|
12
|
-
super(name,
|
|
13
|
-
this.variant = "document";
|
|
27
|
+
super(name, ReflectionKind.Document, parent);
|
|
14
28
|
this.content = content;
|
|
15
29
|
this.frontmatter = frontmatter;
|
|
16
30
|
if (typeof frontmatter["title"] === "string") {
|
|
@@ -27,7 +41,7 @@ class DocumentReflection extends abstract_1.Reflection {
|
|
|
27
41
|
}
|
|
28
42
|
traverse(callback) {
|
|
29
43
|
for (const child of this.children || []) {
|
|
30
|
-
if (callback(child,
|
|
44
|
+
if (callback(child, TraverseProperty.Documents) === false) {
|
|
31
45
|
return;
|
|
32
46
|
}
|
|
33
47
|
}
|
|
@@ -36,7 +50,7 @@ class DocumentReflection extends abstract_1.Reflection {
|
|
|
36
50
|
return {
|
|
37
51
|
...super.toObject(serializer),
|
|
38
52
|
variant: this.variant,
|
|
39
|
-
content:
|
|
53
|
+
content: Comment.serializeDisplayParts(serializer, this.content),
|
|
40
54
|
frontmatter: this.frontmatter,
|
|
41
55
|
relevanceBoost: this.relevanceBoost,
|
|
42
56
|
children: serializer.toObjectsOptional(this.children),
|
|
@@ -44,10 +58,9 @@ class DocumentReflection extends abstract_1.Reflection {
|
|
|
44
58
|
}
|
|
45
59
|
fromObject(de, obj) {
|
|
46
60
|
super.fromObject(de, obj);
|
|
47
|
-
this.content =
|
|
61
|
+
this.content = Comment.deserializeDisplayParts(de, obj.content);
|
|
48
62
|
this.frontmatter = obj.frontmatter;
|
|
49
63
|
this.relevanceBoost = obj.relevanceBoost;
|
|
50
64
|
this.children = de.reviveMany(obj.children, (obj) => de.reflectionBuilders.document(this, obj));
|
|
51
65
|
}
|
|
52
66
|
}
|
|
53
|
-
exports.DocumentReflection = DocumentReflection;
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract";
|
|
2
|
-
export type { ReflectionVisitor, TraverseCallback } from "./abstract";
|
|
3
|
-
export { ContainerReflection } from "./container";
|
|
4
|
-
export { DeclarationReflection } from "./declaration";
|
|
5
|
-
export type { DeclarationHierarchy } from "./declaration";
|
|
6
|
-
export { DocumentReflection } from "./document";
|
|
7
|
-
export { ReflectionKind } from "./kind";
|
|
8
|
-
export { ParameterReflection } from "./parameter";
|
|
9
|
-
export { ProjectReflection } from "./project";
|
|
10
|
-
export { ReferenceReflection } from "./reference";
|
|
11
|
-
export { ReflectionSymbolId, type ReflectionSymbolIdString, } from "./ReflectionSymbolId";
|
|
12
|
-
export { SignatureReflection } from "./signature";
|
|
13
|
-
export { TypeParameterReflection, VarianceModifier } from "./type-parameter";
|
|
14
|
-
export { splitUnquotedString } from "./utils";
|
|
15
|
-
export type { ReflectionVariant } from "./variant";
|
|
1
|
+
export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract.js";
|
|
2
|
+
export type { ReflectionVisitor, TraverseCallback, ReflectionId, } from "./abstract.js";
|
|
3
|
+
export { ContainerReflection } from "./container.js";
|
|
4
|
+
export { DeclarationReflection } from "./declaration.js";
|
|
5
|
+
export type { DeclarationHierarchy } from "./declaration.js";
|
|
6
|
+
export { DocumentReflection } from "./document.js";
|
|
7
|
+
export { ReflectionKind } from "./kind.js";
|
|
8
|
+
export { ParameterReflection } from "./parameter.js";
|
|
9
|
+
export { ProjectReflection } from "./project.js";
|
|
10
|
+
export { ReferenceReflection } from "./reference.js";
|
|
11
|
+
export { ReflectionSymbolId, type ReflectionSymbolIdString, } from "./ReflectionSymbolId.js";
|
|
12
|
+
export { SignatureReflection } from "./signature.js";
|
|
13
|
+
export { TypeParameterReflection, VarianceModifier } from "./type-parameter.js";
|
|
14
|
+
export { splitUnquotedString } from "./utils.js";
|
|
15
|
+
export type { ReflectionVariant, SomeReflection } from "./variant.js";
|
|
@@ -1,31 +1,12 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
var document_1 = require("./document");
|
|
14
|
-
Object.defineProperty(exports, "DocumentReflection", { enumerable: true, get: function () { return document_1.DocumentReflection; } });
|
|
15
|
-
var kind_1 = require("./kind");
|
|
16
|
-
Object.defineProperty(exports, "ReflectionKind", { enumerable: true, get: function () { return kind_1.ReflectionKind; } });
|
|
17
|
-
var parameter_1 = require("./parameter");
|
|
18
|
-
Object.defineProperty(exports, "ParameterReflection", { enumerable: true, get: function () { return parameter_1.ParameterReflection; } });
|
|
19
|
-
var project_1 = require("./project");
|
|
20
|
-
Object.defineProperty(exports, "ProjectReflection", { enumerable: true, get: function () { return project_1.ProjectReflection; } });
|
|
21
|
-
var reference_1 = require("./reference");
|
|
22
|
-
Object.defineProperty(exports, "ReferenceReflection", { enumerable: true, get: function () { return reference_1.ReferenceReflection; } });
|
|
23
|
-
var ReflectionSymbolId_1 = require("./ReflectionSymbolId");
|
|
24
|
-
Object.defineProperty(exports, "ReflectionSymbolId", { enumerable: true, get: function () { return ReflectionSymbolId_1.ReflectionSymbolId; } });
|
|
25
|
-
var signature_1 = require("./signature");
|
|
26
|
-
Object.defineProperty(exports, "SignatureReflection", { enumerable: true, get: function () { return signature_1.SignatureReflection; } });
|
|
27
|
-
var type_parameter_1 = require("./type-parameter");
|
|
28
|
-
Object.defineProperty(exports, "TypeParameterReflection", { enumerable: true, get: function () { return type_parameter_1.TypeParameterReflection; } });
|
|
29
|
-
Object.defineProperty(exports, "VarianceModifier", { enumerable: true, get: function () { return type_parameter_1.VarianceModifier; } });
|
|
30
|
-
var utils_1 = require("./utils");
|
|
31
|
-
Object.defineProperty(exports, "splitUnquotedString", { enumerable: true, get: function () { return utils_1.splitUnquotedString; } });
|
|
1
|
+
export { Reflection, ReflectionFlag, ReflectionFlags, TraverseProperty, } from "./abstract.js";
|
|
2
|
+
export { ContainerReflection } from "./container.js";
|
|
3
|
+
export { DeclarationReflection } from "./declaration.js";
|
|
4
|
+
export { DocumentReflection } from "./document.js";
|
|
5
|
+
export { ReflectionKind } from "./kind.js";
|
|
6
|
+
export { ParameterReflection } from "./parameter.js";
|
|
7
|
+
export { ProjectReflection } from "./project.js";
|
|
8
|
+
export { ReferenceReflection } from "./reference.js";
|
|
9
|
+
export { ReflectionSymbolId, } from "./ReflectionSymbolId.js";
|
|
10
|
+
export { SignatureReflection } from "./signature.js";
|
|
11
|
+
export { TypeParameterReflection, VarianceModifier } from "./type-parameter.js";
|
|
12
|
+
export { splitUnquotedString } from "./utils.js";
|
|
@@ -1,11 +1,8 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ReflectionKind = void 0;
|
|
4
1
|
/**
|
|
5
2
|
* Defines the available reflection kinds.
|
|
6
3
|
* @category Reflections
|
|
7
4
|
*/
|
|
8
|
-
var ReflectionKind;
|
|
5
|
+
export var ReflectionKind;
|
|
9
6
|
(function (ReflectionKind) {
|
|
10
7
|
ReflectionKind[ReflectionKind["Project"] = 1] = "Project";
|
|
11
8
|
ReflectionKind[ReflectionKind["Module"] = 2] = "Module";
|
|
@@ -34,7 +31,7 @@ var ReflectionKind;
|
|
|
34
31
|
* Generic non-ts content to be included in the generated docs as its own page.
|
|
35
32
|
*/
|
|
36
33
|
ReflectionKind[ReflectionKind["Document"] = 8388608] = "Document";
|
|
37
|
-
})(ReflectionKind || (
|
|
34
|
+
})(ReflectionKind || (ReflectionKind = {}));
|
|
38
35
|
/** @category Reflections */
|
|
39
36
|
(function (ReflectionKind) {
|
|
40
37
|
/** @internal */
|
|
@@ -159,7 +156,7 @@ var ReflectionKind;
|
|
|
159
156
|
.toLowerCase()}`;
|
|
160
157
|
}
|
|
161
158
|
ReflectionKind.classString = classString;
|
|
162
|
-
})(ReflectionKind || (
|
|
159
|
+
})(ReflectionKind || (ReflectionKind = {}));
|
|
163
160
|
function getKindString(kind) {
|
|
164
161
|
return ReflectionKind[kind].replace(/(.)([A-Z])/g, (_m, a, b) => a + " " + b.toLowerCase());
|
|
165
162
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { SomeType } from "
|
|
2
|
-
import { Reflection, type TraverseCallback } from "./abstract";
|
|
3
|
-
import type { SignatureReflection } from "./signature";
|
|
4
|
-
import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
|
|
1
|
+
import type { SomeType } from "../index.js";
|
|
2
|
+
import { Reflection, type TraverseCallback } from "./abstract.js";
|
|
3
|
+
import type { SignatureReflection } from "./signature.js";
|
|
4
|
+
import type { Serializer, JSONOutput, Deserializer } from "../../serialization/index.js";
|
|
5
5
|
/**
|
|
6
6
|
* @category Reflections
|
|
7
7
|
*/
|
|
@@ -11,6 +11,7 @@ export declare class ParameterReflection extends Reflection {
|
|
|
11
11
|
defaultValue?: string;
|
|
12
12
|
type?: SomeType;
|
|
13
13
|
traverse(callback: TraverseCallback): void;
|
|
14
|
+
isParameter(): this is ParameterReflection;
|
|
14
15
|
/**
|
|
15
16
|
* Return a string representation of this reflection.
|
|
16
17
|
*/
|