UNPKG

2.6 kBTypeScriptView Raw
1export interface JsonDocs {
2 components: JsonDocsComponent[];
3 timestamp: string;
4 compiler: {
5 name: string;
6 version: string;
7 typescriptVersion: string;
8 };
9}
10export interface JsonDocsComponent {
11 dirPath?: string;
12 fileName?: string;
13 filePath?: string;
14 readmePath?: string;
15 usagesDir?: string;
16 encapsulation: 'shadow' | 'scoped' | 'none';
17 tag: string;
18 readme: string;
19 docs: string;
20 docsTags: JsonDocsTag[];
21 usage: JsonDocsUsage;
22 props: JsonDocsProp[];
23 methods: JsonDocsMethod[];
24 events: JsonDocsEvent[];
25 listeners: JsonDocsListener[];
26 styles: JsonDocsStyle[];
27 slots: JsonDocsSlot[];
28 parts: JsonDocsPart[];
29 dependents: string[];
30 dependencies: string[];
31 dependencyGraph: JsonDocsDependencyGraph;
32 deprecation?: string;
33}
34export interface JsonDocsDependencyGraph {
35 [tagName: string]: string[];
36}
37export interface JsonDocsTag {
38 name: string;
39 text?: string;
40}
41export interface JsonDocsValue {
42 value?: string;
43 type: string;
44}
45export interface JsonDocsUsage {
46 [key: string]: string;
47}
48export interface JsonDocsProp {
49 name: string;
50 type: string;
51 mutable: boolean;
52 /**
53 * The name of the attribute that is exposed to configure a compiled web component
54 */
55 attr?: string;
56 reflectToAttr: boolean;
57 docs: string;
58 docsTags: JsonDocsTag[];
59 default: string;
60 deprecation?: string;
61 values: JsonDocsValue[];
62 optional: boolean;
63 required: boolean;
64}
65export interface JsonDocsMethod {
66 name: string;
67 docs: string;
68 docsTags: JsonDocsTag[];
69 deprecation?: string;
70 signature: string;
71 returns: JsonDocsMethodReturn;
72 parameters: JsonDocMethodParameter[];
73}
74export interface JsonDocsMethodReturn {
75 type: string;
76 docs: string;
77}
78export interface JsonDocMethodParameter {
79 name: string;
80 type: string;
81 docs: string;
82}
83export interface JsonDocsEvent {
84 event: string;
85 bubbles: boolean;
86 cancelable: boolean;
87 composed: boolean;
88 docs: string;
89 docsTags: JsonDocsTag[];
90 deprecation?: string;
91 detail: string;
92}
93export interface JsonDocsStyle {
94 name: string;
95 docs: string;
96 annotation: string;
97}
98export interface JsonDocsListener {
99 event: string;
100 target?: string;
101 capture: boolean;
102 passive: boolean;
103}
104export interface JsonDocsSlot {
105 name: string;
106 docs: string;
107}
108export interface JsonDocsPart {
109 name: string;
110 docs: string;
111}
112export interface StyleDoc {
113 name: string;
114 docs: string;
115 annotation: 'prop';
116}