stencil-public-docs.d.ts 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. export interface JsonDocs {
  2. components: JsonDocsComponent[];
  3. timestamp: string;
  4. compiler: {
  5. name: string;
  6. version: string;
  7. typescriptVersion: string;
  8. };
  9. }
  10. export 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. }
  34. export interface JsonDocsDependencyGraph {
  35. [tagName: string]: string[];
  36. }
  37. export interface JsonDocsTag {
  38. name: string;
  39. text?: string;
  40. }
  41. export interface JsonDocsValue {
  42. value?: string;
  43. type: string;
  44. }
  45. export interface JsonDocsUsage {
  46. [key: string]: string;
  47. }
  48. export interface JsonDocsProp {
  49. name: string;
  50. type: string;
  51. mutable: boolean;
  52. attr?: string;
  53. reflectToAttr: boolean;
  54. docs: string;
  55. docsTags: JsonDocsTag[];
  56. default: string;
  57. deprecation?: string;
  58. values: JsonDocsValue[];
  59. optional: boolean;
  60. required: boolean;
  61. }
  62. export interface JsonDocsMethod {
  63. name: string;
  64. docs: string;
  65. docsTags: JsonDocsTag[];
  66. deprecation?: string;
  67. signature: string;
  68. returns: JsonDocsMethodReturn;
  69. parameters: JsonDocMethodParameter[];
  70. }
  71. export interface JsonDocsMethodReturn {
  72. type: string;
  73. docs: string;
  74. }
  75. export interface JsonDocMethodParameter {
  76. name: string;
  77. type: string;
  78. docs: string;
  79. }
  80. export interface JsonDocsEvent {
  81. event: string;
  82. bubbles: boolean;
  83. cancelable: boolean;
  84. composed: boolean;
  85. docs: string;
  86. docsTags: JsonDocsTag[];
  87. deprecation?: string;
  88. detail: string;
  89. }
  90. export interface JsonDocsStyle {
  91. name: string;
  92. docs: string;
  93. annotation: string;
  94. }
  95. export interface JsonDocsListener {
  96. event: string;
  97. target?: string;
  98. capture: boolean;
  99. passive: boolean;
  100. }
  101. export interface JsonDocsSlot {
  102. name: string;
  103. docs: string;
  104. }
  105. export interface JsonDocsPart {
  106. name: string;
  107. docs: string;
  108. }
  109. export interface StyleDoc {
  110. name: string;
  111. docs: string;
  112. annotation: 'prop';
  113. }