1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
|
9 | export interface EntryCollection {
|
10 | moduleName: string;
|
11 | normalizedModuleName: string;
|
12 | moduleLabel: string;
|
13 | entries: DocEntry[];
|
14 | }
|
15 |
|
16 | export declare enum EntryType {
|
17 | Block = "block",
|
18 | Component = "component",
|
19 | Constant = "constant",
|
20 | Decorator = "decorator",
|
21 | Directive = "directive",
|
22 | Element = "element",
|
23 | Enum = "enum",
|
24 | Function = "function",
|
25 | Interface = "interface",
|
26 | NgModule = "ng_module",
|
27 | Pipe = "pipe",
|
28 | TypeAlias = "type_alias",
|
29 | UndecoratedClass = "undecorated_class",
|
30 | InitializerApiFunction = "initializer_api_function"
|
31 | }
|
32 |
|
33 | export declare enum MemberType {
|
34 | Property = "property",
|
35 | Method = "method",
|
36 | Getter = "getter",
|
37 | Setter = "setter",
|
38 | EnumItem = "enum_item"
|
39 | }
|
40 | export declare enum DecoratorType {
|
41 | Class = "class",
|
42 | Member = "member",
|
43 | Parameter = "parameter"
|
44 | }
|
45 |
|
46 | export declare enum MemberTags {
|
47 | Abstract = "abstract",
|
48 | Static = "static",
|
49 | Readonly = "readonly",
|
50 | Protected = "protected",
|
51 | Optional = "optional",
|
52 | Input = "input",
|
53 | Output = "output",
|
54 | Inherited = "override"
|
55 | }
|
56 |
|
57 | export interface JsDocTagEntry {
|
58 | name: string;
|
59 | comment: string;
|
60 | }
|
61 |
|
62 | export interface GenericEntry {
|
63 | name: string;
|
64 | constraint: string | undefined;
|
65 | default: string | undefined;
|
66 | }
|
67 | export interface SourceEntry {
|
68 | filePath: string;
|
69 | startLine: number;
|
70 | endLine: number;
|
71 | }
|
72 | export interface DocEntryWithSourceInfo extends DocEntry {
|
73 | source: SourceEntry;
|
74 | }
|
75 |
|
76 | export interface DocEntry {
|
77 | entryType: EntryType;
|
78 | name: string;
|
79 | description: string;
|
80 | rawComment: string;
|
81 | jsdocTags: JsDocTagEntry[];
|
82 | }
|
83 |
|
84 | export interface ConstantEntry extends DocEntry {
|
85 | type: string;
|
86 | }
|
87 |
|
88 | export interface TypeAliasEntry extends ConstantEntry {
|
89 | generics: GenericEntry[];
|
90 | }
|
91 |
|
92 | export interface ClassEntry extends DocEntry {
|
93 | isAbstract: boolean;
|
94 | members: MemberEntry[];
|
95 | extends?: string;
|
96 | generics: GenericEntry[];
|
97 | implements: string[];
|
98 | }
|
99 |
|
100 | export type InterfaceEntry = ClassEntry;
|
101 |
|
102 | export interface EnumEntry extends DocEntry {
|
103 | members: EnumMemberEntry[];
|
104 | }
|
105 |
|
106 | export interface DecoratorEntry extends DocEntry {
|
107 | decoratorType: DecoratorType;
|
108 | members: PropertyEntry[];
|
109 | }
|
110 |
|
111 | export interface DirectiveEntry extends ClassEntry {
|
112 | selector: string;
|
113 | exportAs: string[];
|
114 | isStandalone: boolean;
|
115 | }
|
116 | export interface PipeEntry extends ClassEntry {
|
117 | pipeName: string;
|
118 | isStandalone: boolean;
|
119 | }
|
120 | export interface FunctionSignatureMetadata extends DocEntry {
|
121 | params: ParameterEntry[];
|
122 | returnType: string;
|
123 | returnDescription?: string;
|
124 | generics: GenericEntry[];
|
125 | isNewType: boolean;
|
126 | }
|
127 |
|
128 | export interface MemberEntry {
|
129 | name: string;
|
130 | memberType: MemberType;
|
131 | memberTags: MemberTags[];
|
132 | description: string;
|
133 | jsdocTags: JsDocTagEntry[];
|
134 | }
|
135 |
|
136 | export interface EnumMemberEntry extends MemberEntry {
|
137 | type: string;
|
138 | value: string;
|
139 | }
|
140 |
|
141 | export interface PropertyEntry extends MemberEntry {
|
142 | type: string;
|
143 | inputAlias?: string;
|
144 | outputAlias?: string;
|
145 | isRequiredInput?: boolean;
|
146 | }
|
147 |
|
148 | export type MethodEntry = MemberEntry & FunctionEntry;
|
149 |
|
150 | export interface ParameterEntry {
|
151 | name: string;
|
152 | description: string;
|
153 | type: string;
|
154 | isOptional: boolean;
|
155 | isRestParam: boolean;
|
156 | }
|
157 | export type FunctionEntry = FunctionDefinitionEntry & DocEntry & {
|
158 | implementation: FunctionSignatureMetadata;
|
159 | };
|
160 |
|
161 | export interface FunctionDefinitionEntry {
|
162 | name: string;
|
163 | signatures: FunctionSignatureMetadata[];
|
164 | implementation: FunctionSignatureMetadata | null;
|
165 | }
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 | export interface InitializerApiFunctionEntry extends DocEntry {
|
180 | callFunction: FunctionDefinitionEntry;
|
181 | subFunctions: FunctionDefinitionEntry[];
|
182 | __docsMetadata__?: {
|
183 | |
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 | showTypesInSignaturePreview?: boolean;
|
192 | };
|
193 | }
|
194 | export declare function isDocEntryWithSourceInfo(entry: DocEntry): entry is DocEntryWithSourceInfo;
|