docs-json.d.ts 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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. /**
  57. * The name of the attribute that is exposed to configure a compiled web component
  58. */
  59. attr?: string;
  60. reflectToAttr: boolean;
  61. docs: string;
  62. docsTags: JsonDocsTag[];
  63. default: string;
  64. deprecation?: string;
  65. values: JsonDocsValue[];
  66. optional: boolean;
  67. required: boolean;
  68. }
  69. export interface JsonDocsMethod {
  70. name: string;
  71. docs: string;
  72. docsTags: JsonDocsTag[];
  73. deprecation?: string;
  74. signature: string;
  75. returns: JsonDocsMethodReturn;
  76. parameters: JsonDocMethodParameter[];
  77. }
  78. export interface JsonDocsMethodReturn {
  79. type: string;
  80. docs: string;
  81. }
  82. export interface JsonDocMethodParameter {
  83. name: string;
  84. type: string;
  85. docs: string;
  86. }
  87. export interface JsonDocsEvent {
  88. event: string;
  89. bubbles: boolean;
  90. cancelable: boolean;
  91. composed: boolean;
  92. docs: string;
  93. docsTags: JsonDocsTag[];
  94. deprecation?: string;
  95. detail: string;
  96. }
  97. export interface JsonDocsStyle {
  98. name: string;
  99. docs: string;
  100. annotation: string;
  101. }
  102. export interface JsonDocsListener {
  103. event: string;
  104. target?: string;
  105. capture: boolean;
  106. passive: boolean;
  107. }
  108. export interface JsonDocsSlot {
  109. name: string;
  110. docs: string;
  111. }
  112. export interface JsonDocsPart {
  113. name: string;
  114. docs: string;
  115. }
  116. export interface StyleDoc {
  117. name: string;
  118. docs: string;
  119. annotation: 'prop';
  120. }
  121. declare const _default: JsonDocs;
  122. export default _default;