docs-json.d.ts 2.6 KB

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