UNPKG

2.21 kBTypeScriptView Raw
1export interface Method {
2 name: string;
3 args: Argument[];
4 returnType: string;
5 decorators?: Decorator[];
6 description?: string;
7 rawdescription?: string;
8}
9export interface JsDocTag {
10 comment?: string;
11 tagName?: {
12 escapedText?: string;
13 };
14}
15export interface Property {
16 name: string;
17 decorators?: Decorator[];
18 type: string;
19 optional: boolean;
20 defaultValue?: string;
21 description?: string;
22 rawdescription?: string;
23 jsdoctags?: JsDocTag[];
24}
25export interface Class {
26 name: string;
27 ngname: string;
28 type: 'pipe';
29 properties: Property[];
30 methods: Method[];
31 description?: string;
32 rawdescription?: string;
33}
34export interface Injectable {
35 name: string;
36 type: 'injectable';
37 properties: Property[];
38 methods: Method[];
39 description?: string;
40 rawdescription?: string;
41}
42export interface Pipe {
43 name: string;
44 type: 'class';
45 properties: Property[];
46 methods: Method[];
47 description?: string;
48 rawdescription?: string;
49}
50export interface Directive {
51 name: string;
52 type: 'directive' | 'component';
53 propertiesClass: Property[];
54 inputsClass: Property[];
55 outputsClass: Property[];
56 methodsClass: Method[];
57 description?: string;
58 rawdescription?: string;
59}
60export type Component = Directive;
61export interface Argument {
62 name: string;
63 type: string;
64 optional?: boolean;
65}
66export interface Decorator {
67 name: string;
68}
69export interface TypeAlias {
70 name: string;
71 ctype: string;
72 subtype: string;
73 rawtype: string;
74 file: string;
75 kind: number;
76 description?: string;
77 rawdescription?: string;
78}
79export interface EnumType {
80 name: string;
81 childs: EnumTypeChild[];
82 ctype: string;
83 subtype: string;
84 file: string;
85 description?: string;
86 rawdescription?: string;
87}
88export interface EnumTypeChild {
89 name: string;
90 value?: string;
91}
92export interface CompodocJson {
93 directives: Directive[];
94 components: Component[];
95 pipes: Pipe[];
96 injectables: Injectable[];
97 classes: Class[];
98 miscellaneous?: {
99 typealiases?: TypeAlias[];
100 enumerations?: EnumType[];
101 };
102}