UNPKG

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