@skyux/docs-tools 9.0.0-alpha.1 → 9.0.0-alpha.2
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/esm2022/modules/type-definitions/type-definitions.service.mjs +8 -7
- package/esm2022/modules/type-definitions/typedoc-adapter.service.mjs +15 -13
- package/esm2022/modules/type-definitions/typedoc-types.mjs +34 -2
- package/fesm2022/skyux-docs-tools.mjs +53 -18
- package/fesm2022/skyux-docs-tools.mjs.map +1 -1
- package/modules/type-definitions/typedoc-types.d.ts +37 -5
- package/package.json +2 -2
|
@@ -17,7 +17,7 @@ export interface TypeDocSource {
|
|
|
17
17
|
}
|
|
18
18
|
export interface TypeDocSignature {
|
|
19
19
|
comment?: TypeDocComment;
|
|
20
|
-
|
|
20
|
+
kind?: TypeDocKind.CallSignature | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature;
|
|
21
21
|
name: string;
|
|
22
22
|
parameters?: TypeDocParameter[];
|
|
23
23
|
returnType?: TypeDocType;
|
|
@@ -26,7 +26,7 @@ export interface TypeDocSignature {
|
|
|
26
26
|
}
|
|
27
27
|
export interface TypeDocTypeParameter {
|
|
28
28
|
name: string;
|
|
29
|
-
|
|
29
|
+
kind: TypeDocKind.TypeParameter;
|
|
30
30
|
type?: TypeDocType;
|
|
31
31
|
}
|
|
32
32
|
export interface TypeDocType {
|
|
@@ -53,7 +53,7 @@ export interface TypeDocType {
|
|
|
53
53
|
export interface TypeDocParameter {
|
|
54
54
|
comment?: TypeDocComment;
|
|
55
55
|
defaultValue?: string;
|
|
56
|
-
|
|
56
|
+
kind: TypeDocKind.Parameter;
|
|
57
57
|
name: string;
|
|
58
58
|
type: TypeDocType;
|
|
59
59
|
flags?: {
|
|
@@ -74,7 +74,7 @@ export interface TypeDocEntryChild {
|
|
|
74
74
|
isOptional?: boolean;
|
|
75
75
|
isStatic?: boolean;
|
|
76
76
|
};
|
|
77
|
-
|
|
77
|
+
kind?: TypeDocKind.Accessor | TypeDocKind.CallSignature | TypeDocKind.Constructor | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature | TypeDocKind.EnumMember | TypeDocKind.Parameter | TypeDocKind.Property | TypeDocKind.Method;
|
|
78
78
|
getSignature?: {
|
|
79
79
|
comment: TypeDocComment;
|
|
80
80
|
name: string;
|
|
@@ -102,10 +102,42 @@ export interface TypeDocEntry {
|
|
|
102
102
|
name: 'Component' | 'Directive' | 'Injectable' | 'NgModule' | 'Pipe';
|
|
103
103
|
type: TypeDocType;
|
|
104
104
|
}[];
|
|
105
|
-
|
|
105
|
+
kind?: TypeDocKind.Class | TypeDocKind.Enum | TypeDocKind.Interface | TypeDocKind.TypeAlias;
|
|
106
106
|
indexSignature?: TypeDocSignature;
|
|
107
107
|
name?: string;
|
|
108
108
|
sources?: TypeDocSource[];
|
|
109
109
|
type?: TypeDocType;
|
|
110
110
|
typeParameter?: TypeDocTypeParameter[];
|
|
111
111
|
}
|
|
112
|
+
/**
|
|
113
|
+
* This enum comes from:
|
|
114
|
+
* https://github.com/TypeStrong/typedoc/blob/v0.24.8/src/lib/models/reflections/kind.ts
|
|
115
|
+
* The enum is up to date as of version `0.24.8`.
|
|
116
|
+
*/
|
|
117
|
+
export declare enum TypeDocKind {
|
|
118
|
+
Project = 1,
|
|
119
|
+
Module = 2,
|
|
120
|
+
Namespace = 4,
|
|
121
|
+
Enum = 8,
|
|
122
|
+
EnumMember = 16,
|
|
123
|
+
Variable = 32,
|
|
124
|
+
Function = 64,
|
|
125
|
+
Class = 128,
|
|
126
|
+
Interface = 256,
|
|
127
|
+
Constructor = 512,
|
|
128
|
+
Property = 1024,
|
|
129
|
+
Method = 2048,
|
|
130
|
+
CallSignature = 4096,
|
|
131
|
+
IndexSignature = 8192,
|
|
132
|
+
ConstructorSignature = 16384,
|
|
133
|
+
Parameter = 32768,
|
|
134
|
+
TypeLiteral = 65536,
|
|
135
|
+
TypeParameter = 131072,
|
|
136
|
+
Accessor = 262144,
|
|
137
|
+
GetSignature = 524288,
|
|
138
|
+
SetSignature = 1048576,
|
|
139
|
+
/** @deprecated will be removed in v0.25, not used */
|
|
140
|
+
ObjectLiteral = 2097152,
|
|
141
|
+
TypeAlias = 4194304,
|
|
142
|
+
Reference = 8388608
|
|
143
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyux/docs-tools",
|
|
3
|
-
"version": "9.0.0-alpha.
|
|
3
|
+
"version": "9.0.0-alpha.2",
|
|
4
4
|
"peerDependencies": {
|
|
5
5
|
"@angular/common": "^16.1.8",
|
|
6
6
|
"@angular/core": "^16.1.8",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"@stackblitz/sdk": "1.8.0",
|
|
26
26
|
"lodash.orderby": "4.6.0",
|
|
27
27
|
"marked": "4.1.0",
|
|
28
|
-
"tslib": "^2.6.
|
|
28
|
+
"tslib": "^2.6.2"
|
|
29
29
|
},
|
|
30
30
|
"module": "fesm2022/skyux-docs-tools.mjs",
|
|
31
31
|
"typings": "index.d.ts",
|