@skyux/docs-tools 11.2.1 → 12.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (252) hide show
  1. package/README.md +4 -132
  2. package/css/styles.css +35 -0
  3. package/fesm2022/skyux-docs-tools.mjs +1617 -3171
  4. package/fesm2022/skyux-docs-tools.mjs.map +1 -1
  5. package/index.d.ts +32 -5
  6. package/lib/modules/category-tag/category-color.d.ts +6 -0
  7. package/lib/modules/category-tag/category-tag.component.d.ts +10 -0
  8. package/lib/modules/category-tag/category-tag.module.d.ts +10 -0
  9. package/lib/modules/clipboard/clipboard-button.directive.d.ts +12 -0
  10. package/lib/modules/clipboard/clipboard.module.d.ts +10 -0
  11. package/lib/modules/clipboard/clipboard.service.d.ts +15 -0
  12. package/lib/modules/code-example-viewer/code-example-viewer.component.d.ts +23 -0
  13. package/lib/modules/code-example-viewer/code-example-viewer.module.d.ts +10 -0
  14. package/lib/modules/code-example-viewer/stackblitz-launch-config.d.ts +10 -0
  15. package/lib/modules/code-example-viewer/stackblitz.service.d.ts +11 -0
  16. package/lib/modules/code-highlight/code-highlight-language.d.ts +12 -0
  17. package/lib/modules/code-highlight/code-highlight.pipe.d.ts +12 -0
  18. package/lib/modules/code-highlight/code-highlight.service.d.ts +11 -0
  19. package/lib/modules/code-snippet/code-snippet-toolbar.component.d.ts +9 -0
  20. package/lib/modules/code-snippet/code-snippet-wrapper.component.d.ts +12 -0
  21. package/lib/modules/code-snippet/code-snippet.component.d.ts +16 -0
  22. package/lib/modules/code-snippet/code-snippet.module.d.ts +11 -0
  23. package/lib/modules/heading-anchor/heading-anchor-heading-level.d.ts +4 -0
  24. package/lib/modules/heading-anchor/heading-anchor-heading-text-format.d.ts +4 -0
  25. package/lib/modules/heading-anchor/heading-anchor-link.d.ts +12 -0
  26. package/lib/modules/heading-anchor/heading-anchor.component.d.ts +24 -0
  27. package/{modules → lib/modules}/heading-anchor/heading-anchor.module.d.ts +4 -4
  28. package/lib/modules/heading-anchor/heading-anchor.service.d.ts +16 -0
  29. package/{modules → lib/modules}/shared/sky-docs-tools-resources.module.d.ts +0 -4
  30. package/lib/modules/showcase/code-example-types/code-example-types-token.d.ts +9 -0
  31. package/lib/modules/showcase/code-example-types/code-example-types.pipe.d.ts +11 -0
  32. package/lib/modules/showcase/code-example-types/provide-code-example-types.d.ts +14 -0
  33. package/lib/modules/showcase/showcase-area-development.component.d.ts +11 -0
  34. package/lib/modules/showcase/showcase-area-examples.component.d.ts +11 -0
  35. package/lib/modules/showcase/showcase-area-overview.component.d.ts +9 -0
  36. package/lib/modules/showcase/showcase-area-testing.component.d.ts +11 -0
  37. package/lib/modules/showcase/showcase-host.service.d.ts +15 -0
  38. package/lib/modules/showcase/showcase.component.d.ts +19 -0
  39. package/lib/modules/showcase/showcase.module.d.ts +14 -0
  40. package/lib/modules/table-of-contents/table-of-contents-links.d.ts +7 -0
  41. package/lib/modules/table-of-contents/table-of-contents-page.component.d.ts +15 -0
  42. package/lib/modules/table-of-contents/table-of-contents.component.d.ts +11 -0
  43. package/lib/modules/table-of-contents/table-of-contents.module.d.ts +11 -0
  44. package/lib/modules/type-definition/box.component.d.ts +12 -0
  45. package/lib/modules/type-definition/deprecation-reason.component.d.ts +9 -0
  46. package/lib/modules/type-definition/description.component.d.ts +10 -0
  47. package/lib/modules/type-definition/pipes/default-value.pipe.d.ts +11 -0
  48. package/lib/modules/type-definition/pipes/enum-signature.pipe.d.ts +11 -0
  49. package/lib/modules/type-definition/pipes/escape-html.pipe.d.ts +10 -0
  50. package/lib/modules/type-definition/pipes/function-signature.pipe.d.ts +12 -0
  51. package/lib/modules/type-definition/pipes/interface-signature.pipe.d.ts +11 -0
  52. package/{modules/markdown → lib/modules/type-definition/pipes}/markdown.pipe.d.ts +5 -2
  53. package/lib/modules/type-definition/pipes/method-name.pipe.d.ts +12 -0
  54. package/lib/modules/type-definition/pipes/parameter-name.pipe.d.ts +11 -0
  55. package/lib/modules/type-definition/pipes/property-name.pipe.d.ts +12 -0
  56. package/lib/modules/type-definition/pipes/type-alias-signature.pipe.d.ts +11 -0
  57. package/lib/modules/type-definition/pipes/type-anchor-links.pipe.d.ts +14 -0
  58. package/lib/modules/type-definition/pipes/type-definition-kind-to-category-color.pipe.d.ts +12 -0
  59. package/lib/modules/type-definition/pipes/type-definition-kind-to-label.pipe.d.ts +11 -0
  60. package/lib/modules/type-definition/property-definition.d.ts +5 -0
  61. package/lib/modules/type-definition/type-anchor-ids.service.d.ts +14 -0
  62. package/lib/modules/type-definition/type-definition.component.d.ts +19 -0
  63. package/lib/modules/type-definition/type-definition.module.d.ts +10 -0
  64. package/package.json +39 -28
  65. package/LICENSE +0 -21
  66. package/css/docs-tools.css +0 -70
  67. package/docs-tools.module.d.ts +0 -14
  68. package/esm2022/docs-tools.module.mjs +0 -36
  69. package/esm2022/modules/anatomy/anatomy-item.component.mjs +0 -17
  70. package/esm2022/modules/anatomy/anatomy-thumbnail.component.mjs +0 -27
  71. package/esm2022/modules/anatomy/anatomy.component.mjs +0 -25
  72. package/esm2022/modules/anatomy/anatomy.module.mjs +0 -46
  73. package/esm2022/modules/code-examples/code-example-module-dependencies.mjs +0 -2
  74. package/esm2022/modules/code-examples/code-example-theme.mjs +0 -6
  75. package/esm2022/modules/code-examples/code-example.component.mjs +0 -68
  76. package/esm2022/modules/code-examples/code-example.mjs +0 -2
  77. package/esm2022/modules/code-examples/code-examples-editor.service.mjs +0 -368
  78. package/esm2022/modules/code-examples/code-examples.component.mjs +0 -98
  79. package/esm2022/modules/code-examples/code-examples.module.mjs +0 -41
  80. package/esm2022/modules/demo/demo-content-alignment.mjs +0 -2
  81. package/esm2022/modules/demo/demo-control-panel-change.mjs +0 -2
  82. package/esm2022/modules/demo/demo-control-panel-checkbox.component.mjs +0 -84
  83. package/esm2022/modules/demo/demo-control-panel-radio-choice.mjs +0 -2
  84. package/esm2022/modules/demo/demo-control-panel-radio-group.component.mjs +0 -80
  85. package/esm2022/modules/demo/demo-control-panel-section.component.mjs +0 -22
  86. package/esm2022/modules/demo/demo-control-panel.component.mjs +0 -85
  87. package/esm2022/modules/demo/demo-custom-control-panel.component.mjs +0 -20
  88. package/esm2022/modules/demo/demo.component.mjs +0 -58
  89. package/esm2022/modules/demo/demo.module.mjs +0 -72
  90. package/esm2022/modules/demo-page/demo-page-dom-adapter.service.mjs +0 -75
  91. package/esm2022/modules/demo-page/demo-page-module-info.component.mjs +0 -14
  92. package/esm2022/modules/demo-page/demo-page-section.component.mjs +0 -43
  93. package/esm2022/modules/demo-page/demo-page-summary.component.mjs +0 -21
  94. package/esm2022/modules/demo-page/demo-page-title.service.mjs +0 -28
  95. package/esm2022/modules/demo-page/demo-page-type-definitions.component.mjs +0 -24
  96. package/esm2022/modules/demo-page/demo-page.component.mjs +0 -190
  97. package/esm2022/modules/demo-page/demo-page.module.mjs +0 -94
  98. package/esm2022/modules/design-guidelines/design-guideline-thumbnail.component.mjs +0 -27
  99. package/esm2022/modules/design-guidelines/design-guideline.component.mjs +0 -33
  100. package/esm2022/modules/design-guidelines/design-guidelines.component.mjs +0 -11
  101. package/esm2022/modules/design-guidelines/design-guidelines.module.mjs +0 -34
  102. package/esm2022/modules/heading-anchor/heading-anchor.component.mjs +0 -21
  103. package/esm2022/modules/heading-anchor/heading-anchor.module.mjs +0 -20
  104. package/esm2022/modules/markdown/markdown.module.mjs +0 -17
  105. package/esm2022/modules/markdown/markdown.pipe.mjs +0 -20
  106. package/esm2022/modules/module-info/module-info.component.mjs +0 -72
  107. package/esm2022/modules/module-info/module-info.module.mjs +0 -40
  108. package/esm2022/modules/safe-html/safe-html.component.mjs +0 -20
  109. package/esm2022/modules/safe-html/safe-html.module.mjs +0 -18
  110. package/esm2022/modules/shared/docs-tools-component-info.mjs +0 -2
  111. package/esm2022/modules/shared/docs-tools-options.mjs +0 -3
  112. package/esm2022/modules/shared/docs-tools-site-options.mjs +0 -3
  113. package/esm2022/modules/shared/docs-tools-supportal.service.mjs +0 -23
  114. package/esm2022/modules/shared/sky-docs-tools-resources.module.mjs +0 -55
  115. package/esm2022/modules/source-code/source-code-file.mjs +0 -2
  116. package/esm2022/modules/source-code/source-code-provider.mjs +0 -13
  117. package/esm2022/modules/source-code/source-code.service.mjs +0 -42
  118. package/esm2022/modules/thumbnail/thumbnail.component.mjs +0 -28
  119. package/esm2022/modules/thumbnail/thumbnail.module.mjs +0 -19
  120. package/esm2022/modules/type-definitions/anchor-link-service-config.mjs +0 -2
  121. package/esm2022/modules/type-definitions/anchor-link-service-format.mjs +0 -2
  122. package/esm2022/modules/type-definitions/anchor-link.mjs +0 -2
  123. package/esm2022/modules/type-definitions/anchor-link.service.mjs +0 -106
  124. package/esm2022/modules/type-definitions/call-signature-definition.component.mjs +0 -45
  125. package/esm2022/modules/type-definitions/call-signature-definition.mjs +0 -2
  126. package/esm2022/modules/type-definitions/class-definition.component.mjs +0 -20
  127. package/esm2022/modules/type-definitions/class-definition.mjs +0 -2
  128. package/esm2022/modules/type-definitions/comment-tags.mjs +0 -2
  129. package/esm2022/modules/type-definitions/directive-definition.component.mjs +0 -20
  130. package/esm2022/modules/type-definitions/directive-definition.mjs +0 -2
  131. package/esm2022/modules/type-definitions/entry-child-definition.mjs +0 -2
  132. package/esm2022/modules/type-definitions/entry-definition.mjs +0 -2
  133. package/esm2022/modules/type-definitions/enumeration-definition.component.mjs +0 -19
  134. package/esm2022/modules/type-definitions/enumeration-definition.mjs +0 -2
  135. package/esm2022/modules/type-definitions/enumeration-member-definition.mjs +0 -2
  136. package/esm2022/modules/type-definitions/index-signature-definition.mjs +0 -2
  137. package/esm2022/modules/type-definitions/interface-definition.component.mjs +0 -36
  138. package/esm2022/modules/type-definitions/interface-definition.mjs +0 -2
  139. package/esm2022/modules/type-definitions/interface-property-definition.mjs +0 -2
  140. package/esm2022/modules/type-definitions/method-definition.mjs +0 -2
  141. package/esm2022/modules/type-definitions/method-definitions.component.mjs +0 -72
  142. package/esm2022/modules/type-definitions/parameter-definition.mjs +0 -2
  143. package/esm2022/modules/type-definitions/pipe-definition.component.mjs +0 -20
  144. package/esm2022/modules/type-definitions/pipe-definition.mjs +0 -2
  145. package/esm2022/modules/type-definitions/preview-feature-indicator.component.mjs +0 -13
  146. package/esm2022/modules/type-definitions/property-decorator.mjs +0 -2
  147. package/esm2022/modules/type-definitions/property-definition.mjs +0 -2
  148. package/esm2022/modules/type-definitions/property-definitions.component.mjs +0 -66
  149. package/esm2022/modules/type-definitions/type-alias-definition.component.mjs +0 -37
  150. package/esm2022/modules/type-definitions/type-alias-definition.mjs +0 -2
  151. package/esm2022/modules/type-definitions/type-anchor-links.pipe.mjs +0 -27
  152. package/esm2022/modules/type-definitions/type-definition.mjs +0 -2
  153. package/esm2022/modules/type-definitions/type-definitions-format.service.mjs +0 -254
  154. package/esm2022/modules/type-definitions/type-definitions-provider.mjs +0 -10
  155. package/esm2022/modules/type-definitions/type-definitions.mjs +0 -2
  156. package/esm2022/modules/type-definitions/type-definitions.module.mjs +0 -108
  157. package/esm2022/modules/type-definitions/type-definitions.service.mjs +0 -122
  158. package/esm2022/modules/type-definitions/type-parameter-definition.mjs +0 -2
  159. package/esm2022/modules/type-definitions/typedoc-adapter.service.mjs +0 -614
  160. package/esm2022/modules/type-definitions/typedoc-types.mjs +0 -32
  161. package/esm2022/public-api.mjs +0 -69
  162. package/esm2022/skyux-docs-tools.mjs +0 -5
  163. package/modules/anatomy/anatomy-item.component.d.ts +0 -7
  164. package/modules/anatomy/anatomy-thumbnail.component.d.ts +0 -11
  165. package/modules/anatomy/anatomy.component.d.ts +0 -9
  166. package/modules/anatomy/anatomy.module.d.ts +0 -13
  167. package/modules/code-examples/code-example-module-dependencies.d.ts +0 -6
  168. package/modules/code-examples/code-example-theme.d.ts +0 -4
  169. package/modules/code-examples/code-example.component.d.ts +0 -39
  170. package/modules/code-examples/code-example.d.ts +0 -13
  171. package/modules/code-examples/code-examples-editor.service.d.ts +0 -18
  172. package/modules/code-examples/code-examples.component.d.ts +0 -45
  173. package/modules/code-examples/code-examples.module.d.ts +0 -14
  174. package/modules/demo/demo-content-alignment.d.ts +0 -1
  175. package/modules/demo/demo-control-panel-change.d.ts +0 -9
  176. package/modules/demo/demo-control-panel-checkbox.component.d.ts +0 -63
  177. package/modules/demo/demo-control-panel-radio-choice.d.ts +0 -13
  178. package/modules/demo/demo-control-panel-radio-group.component.d.ts +0 -64
  179. package/modules/demo/demo-control-panel-section.component.d.ts +0 -16
  180. package/modules/demo/demo-control-panel.component.d.ts +0 -34
  181. package/modules/demo/demo-custom-control-panel.component.d.ts +0 -9
  182. package/modules/demo/demo.component.d.ts +0 -32
  183. package/modules/demo/demo.module.d.ts +0 -18
  184. package/modules/demo-page/demo-page-dom-adapter.service.d.ts +0 -24
  185. package/modules/demo-page/demo-page-module-info.component.d.ts +0 -5
  186. package/modules/demo-page/demo-page-section.component.d.ts +0 -22
  187. package/modules/demo-page/demo-page-summary.component.d.ts +0 -15
  188. package/modules/demo-page/demo-page-title.service.d.ts +0 -12
  189. package/modules/demo-page/demo-page-type-definitions.component.d.ts +0 -10
  190. package/modules/demo-page/demo-page.component.d.ts +0 -112
  191. package/modules/demo-page/demo-page.module.d.ts +0 -23
  192. package/modules/design-guidelines/design-guideline-thumbnail.component.d.ts +0 -11
  193. package/modules/design-guidelines/design-guideline.component.d.ts +0 -12
  194. package/modules/design-guidelines/design-guidelines.component.d.ts +0 -5
  195. package/modules/design-guidelines/design-guidelines.module.d.ts +0 -12
  196. package/modules/heading-anchor/heading-anchor.component.d.ts +0 -7
  197. package/modules/markdown/markdown.module.d.ts +0 -7
  198. package/modules/module-info/module-info.component.d.ts +0 -21
  199. package/modules/module-info/module-info.module.d.ts +0 -13
  200. package/modules/safe-html/safe-html.component.d.ts +0 -10
  201. package/modules/safe-html/safe-html.module.d.ts +0 -8
  202. package/modules/shared/docs-tools-component-info.d.ts +0 -13
  203. package/modules/shared/docs-tools-options.d.ts +0 -4
  204. package/modules/shared/docs-tools-site-options.d.ts +0 -3
  205. package/modules/shared/docs-tools-supportal.service.d.ts +0 -11
  206. package/modules/source-code/source-code-file.d.ts +0 -5
  207. package/modules/source-code/source-code-provider.d.ts +0 -6
  208. package/modules/source-code/source-code.service.d.ts +0 -10
  209. package/modules/thumbnail/thumbnail.component.d.ts +0 -11
  210. package/modules/thumbnail/thumbnail.module.d.ts +0 -9
  211. package/modules/type-definitions/anchor-link-service-config.d.ts +0 -6
  212. package/modules/type-definitions/anchor-link-service-format.d.ts +0 -4
  213. package/modules/type-definitions/anchor-link.d.ts +0 -3
  214. package/modules/type-definitions/anchor-link.service.d.ts +0 -24
  215. package/modules/type-definitions/call-signature-definition.component.d.ts +0 -26
  216. package/modules/type-definitions/call-signature-definition.d.ts +0 -9
  217. package/modules/type-definitions/class-definition.component.d.ts +0 -7
  218. package/modules/type-definitions/class-definition.d.ts +0 -11
  219. package/modules/type-definitions/comment-tags.d.ts +0 -14
  220. package/modules/type-definitions/directive-definition.component.d.ts +0 -7
  221. package/modules/type-definitions/directive-definition.d.ts +0 -11
  222. package/modules/type-definitions/entry-child-definition.d.ts +0 -13
  223. package/modules/type-definitions/entry-definition.d.ts +0 -12
  224. package/modules/type-definitions/enumeration-definition.component.d.ts +0 -7
  225. package/modules/type-definitions/enumeration-definition.d.ts +0 -9
  226. package/modules/type-definitions/enumeration-member-definition.d.ts +0 -11
  227. package/modules/type-definitions/index-signature-definition.d.ts +0 -11
  228. package/modules/type-definitions/interface-definition.component.d.ts +0 -14
  229. package/modules/type-definitions/interface-definition.d.ts +0 -11
  230. package/modules/type-definitions/interface-property-definition.d.ts +0 -8
  231. package/modules/type-definitions/method-definition.d.ts +0 -11
  232. package/modules/type-definitions/method-definitions.component.d.ts +0 -36
  233. package/modules/type-definitions/parameter-definition.d.ts +0 -12
  234. package/modules/type-definitions/pipe-definition.component.d.ts +0 -7
  235. package/modules/type-definitions/pipe-definition.d.ts +0 -8
  236. package/modules/type-definitions/preview-feature-indicator.component.d.ts +0 -5
  237. package/modules/type-definitions/property-decorator.d.ts +0 -6
  238. package/modules/type-definitions/property-definition.d.ts +0 -11
  239. package/modules/type-definitions/property-definitions.component.d.ts +0 -39
  240. package/modules/type-definitions/type-alias-definition.component.d.ts +0 -14
  241. package/modules/type-definitions/type-alias-definition.d.ts +0 -11
  242. package/modules/type-definitions/type-anchor-links.pipe.d.ts +0 -14
  243. package/modules/type-definitions/type-definition.d.ts +0 -36
  244. package/modules/type-definitions/type-definitions-format.service.d.ts +0 -55
  245. package/modules/type-definitions/type-definitions-provider.d.ts +0 -10
  246. package/modules/type-definitions/type-definitions.d.ts +0 -20
  247. package/modules/type-definitions/type-definitions.module.d.ts +0 -26
  248. package/modules/type-definitions/type-definitions.service.d.ts +0 -20
  249. package/modules/type-definitions/type-parameter-definition.d.ts +0 -8
  250. package/modules/type-definitions/typedoc-adapter.service.d.ts +0 -49
  251. package/modules/type-definitions/typedoc-types.d.ts +0 -142
  252. package/public-api.d.ts +0 -66
@@ -1,9 +0,0 @@
1
- import { SkyDocsEntryDefinition } from './entry-definition';
2
- import { SkyDocsEnumerationMemberDefinition } from './enumeration-member-definition';
3
- /**
4
- * Describes enumerations.
5
- */
6
- export interface SkyDocsEnumerationDefinition extends SkyDocsEntryDefinition {
7
- hasPreviewFeatures: boolean;
8
- members: SkyDocsEnumerationMemberDefinition[];
9
- }
@@ -1,11 +0,0 @@
1
- /**
2
- * Describes enumeration members.
3
- */
4
- export interface SkyDocsEnumerationMemberDefinition {
5
- codeExample?: string;
6
- codeExampleLanguage?: string;
7
- deprecationWarning?: string;
8
- description?: string;
9
- isPreview: boolean;
10
- name: string;
11
- }
@@ -1,11 +0,0 @@
1
- import { SkyDocsTypeDefinition } from './type-definition';
2
- /**
3
- * Describes index signature types, e.g. `[_: string]: any`.
4
- */
5
- export interface SkyDocsIndexSignatureDefinition {
6
- key: {
7
- name: string;
8
- type: SkyDocsTypeDefinition;
9
- };
10
- type: SkyDocsTypeDefinition;
11
- }
@@ -1,14 +0,0 @@
1
- import { SkyDocsInterfaceDefinition } from './interface-definition';
2
- import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
3
- import * as i0 from "@angular/core";
4
- export declare class SkyDocsInterfaceDefinitionComponent {
5
- private formatService;
6
- set config(value: SkyDocsInterfaceDefinition);
7
- get config(): SkyDocsInterfaceDefinition;
8
- sourceCode: string;
9
- private _config;
10
- constructor(formatService: SkyDocsTypeDefinitionsFormatService);
11
- private updateView;
12
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsInterfaceDefinitionComponent, never>;
13
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsInterfaceDefinitionComponent, "sky-docs-interface-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
14
- }
@@ -1,11 +0,0 @@
1
- import { SkyDocsEntryDefinition } from './entry-definition';
2
- import { SkyDocsInterfacePropertyDefinition } from './interface-property-definition';
3
- import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
4
- /**
5
- * Describes interfaces.
6
- */
7
- export interface SkyDocsInterfaceDefinition extends SkyDocsEntryDefinition {
8
- hasPreviewFeatures: boolean;
9
- properties: SkyDocsInterfacePropertyDefinition[];
10
- typeParameters?: SkyDocsTypeParameterDefinition[];
11
- }
@@ -1,8 +0,0 @@
1
- import { SkyDocsEntryChildDefinition } from './entry-child-definition';
2
- /**
3
- * Describes interface properties.
4
- */
5
- export interface SkyDocsInterfacePropertyDefinition extends SkyDocsEntryChildDefinition {
6
- isOptional: boolean;
7
- isPreview: boolean;
8
- }
@@ -1,11 +0,0 @@
1
- import { SkyDocsEntryChildDefinition } from './entry-child-definition';
2
- import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
3
- /**
4
- * Describes class methods.
5
- */
6
- export interface SkyDocsClassMethodDefinition extends SkyDocsEntryChildDefinition {
7
- isStatic?: boolean;
8
- isPreview: boolean;
9
- typeParameters?: SkyDocsTypeParameterDefinition[];
10
- parentName?: string;
11
- }
@@ -1,36 +0,0 @@
1
- import { ChangeDetectorRef, OnInit } from '@angular/core';
2
- import { SkyMediaQueryService } from '@skyux/core';
3
- import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
4
- import { SkyDocsClassMethodDefinition } from './method-definition';
5
- import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
6
- import * as i0 from "@angular/core";
7
- interface MethodViewModel {
8
- callSignature: SkyDocsCallSignatureDefinition;
9
- codeExample: string;
10
- codeExampleLanguage: string;
11
- deprecationWarning: string;
12
- description: string;
13
- formattedName: string;
14
- sourceCode: string;
15
- isStatic: boolean;
16
- isPreview: boolean;
17
- }
18
- export declare class SkyDocsMethodDefinitionsComponent implements OnInit {
19
- #private;
20
- set config(value: {
21
- methods?: SkyDocsClassMethodDefinition[];
22
- });
23
- get config(): {
24
- methods?: SkyDocsClassMethodDefinition[];
25
- };
26
- deprecationWarningPrefix: string;
27
- isMobile: boolean;
28
- methods: MethodViewModel[];
29
- staticMethods: MethodViewModel[];
30
- constructor(changeDetector: ChangeDetectorRef, formatService: SkyDocsTypeDefinitionsFormatService, mediaQueryService: SkyMediaQueryService);
31
- ngOnInit(): void;
32
- private updateView;
33
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsMethodDefinitionsComponent, never>;
34
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsMethodDefinitionsComponent, "sky-docs-method-definitions", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
35
- }
36
- export {};
@@ -1,12 +0,0 @@
1
- import { SkyDocsTypeDefinition } from './type-definition';
2
- /**
3
- * Describes function and method parameters.
4
- */
5
- export interface SkyDocsParameterDefinition {
6
- defaultValue?: string;
7
- description?: string;
8
- isOptional: boolean;
9
- name: string;
10
- type: SkyDocsTypeDefinition;
11
- typeArguments?: SkyDocsTypeDefinition[];
12
- }
@@ -1,7 +0,0 @@
1
- import { SkyDocsPipeDefinition } from './pipe-definition';
2
- import * as i0 from "@angular/core";
3
- export declare class SkyDocsPipeDefinitionComponent {
4
- config: SkyDocsPipeDefinition;
5
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPipeDefinitionComponent, never>;
6
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPipeDefinitionComponent, "sky-docs-pipe-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
7
- }
@@ -1,8 +0,0 @@
1
- import { SkyDocsEntryDefinition } from './entry-definition';
2
- import { SkyDocsClassMethodDefinition } from './method-definition';
3
- /**
4
- * Describes pipes.
5
- */
6
- export interface SkyDocsPipeDefinition extends SkyDocsEntryDefinition {
7
- transformMethod: SkyDocsClassMethodDefinition;
8
- }
@@ -1,5 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- export declare class SkyDocsPreviewIndicatorComponent {
3
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPreviewIndicatorComponent, never>;
4
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPreviewIndicatorComponent, "sky-docs-preview-feature-indicator", never, {}, {}, never, never, true, never>;
5
- }
@@ -1,6 +0,0 @@
1
- /**
2
- * Describes a property decorator.
3
- */
4
- export interface SkyDocsPropertyDecoratorDefinition {
5
- name: 'Input' | 'Output';
6
- }
@@ -1,11 +0,0 @@
1
- import { SkyDocsEntryChildDefinition } from './entry-child-definition';
2
- import { SkyDocsPropertyDecoratorDefinition } from './property-decorator';
3
- /**
4
- * Describes class properties.
5
- */
6
- export interface SkyDocsClassPropertyDefinition extends SkyDocsEntryChildDefinition {
7
- decorator?: SkyDocsPropertyDecoratorDefinition;
8
- defaultValue?: string;
9
- isOptional: boolean;
10
- isPreview: boolean;
11
- }
@@ -1,39 +0,0 @@
1
- import { ChangeDetectorRef, OnInit } from '@angular/core';
2
- import { SkyMediaQueryService } from '@skyux/core';
3
- import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
4
- import { SkyDocsClassPropertyDefinition } from './property-definition';
5
- import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
6
- import * as i0 from "@angular/core";
7
- interface PropertyViewModel {
8
- callSignature: SkyDocsCallSignatureDefinition;
9
- defaultValue: string;
10
- deprecationWarning: string;
11
- description: string;
12
- formattedName: string;
13
- isOutput: boolean;
14
- isOptional: boolean;
15
- isPreview: boolean;
16
- }
17
- export declare class SkyDocsPropertyDefinitionsComponent implements OnInit {
18
- private changeDetector;
19
- private formatService;
20
- private mediaQueryService;
21
- set config(value: {
22
- properties?: SkyDocsClassPropertyDefinition[];
23
- });
24
- get config(): {
25
- properties?: SkyDocsClassPropertyDefinition[];
26
- };
27
- propertyType: string;
28
- showOptionalStatus: boolean;
29
- deprecationWarningPrefix: string;
30
- isMobile: boolean;
31
- properties: PropertyViewModel[];
32
- private _config;
33
- constructor(changeDetector: ChangeDetectorRef, formatService: SkyDocsTypeDefinitionsFormatService, mediaQueryService: SkyMediaQueryService);
34
- ngOnInit(): void;
35
- private updateView;
36
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPropertyDefinitionsComponent, never>;
37
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPropertyDefinitionsComponent, "sky-docs-property-definitions", never, { "config": { "alias": "config"; "required": false; }; "propertyType": { "alias": "propertyType"; "required": false; }; "showOptionalStatus": { "alias": "showOptionalStatus"; "required": false; }; }, {}, never, never, false, never>;
38
- }
39
- export {};
@@ -1,14 +0,0 @@
1
- import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
2
- import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
3
- import * as i0 from "@angular/core";
4
- export declare class SkyDocsTypeAliasDefinitionComponent {
5
- private formatService;
6
- set config(value: SkyDocsTypeAliasDefinition);
7
- get config(): SkyDocsTypeAliasDefinition;
8
- sourceCode: string;
9
- private _config;
10
- constructor(formatService: SkyDocsTypeDefinitionsFormatService);
11
- private updateView;
12
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeAliasDefinitionComponent, never>;
13
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsTypeAliasDefinitionComponent, "sky-docs-type-alias-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
14
- }
@@ -1,11 +0,0 @@
1
- import { SkyDocsEntryDefinition } from './entry-definition';
2
- import { SkyDocsTypeDefinition } from './type-definition';
3
- import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
4
- /**
5
- * Describes type aliases.
6
- */
7
- export interface SkyDocsTypeAliasDefinition extends SkyDocsEntryDefinition {
8
- isPreview: boolean;
9
- type: SkyDocsTypeDefinition;
10
- typeParameters?: SkyDocsTypeParameterDefinition[];
11
- }
@@ -1,14 +0,0 @@
1
- import { PipeTransform } from '@angular/core';
2
- import { SkyDocsAnchorLinkService } from './anchor-link.service';
3
- import { SkyDocsAnchorLinkServiceFormatType } from './anchor-link-service-format';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Adds same-page anchor tags around known TypeScript types.
7
- */
8
- export declare class SkyDocsTypeAnchorLinksPipe implements PipeTransform {
9
- private anchorLinkService;
10
- constructor(anchorLinkService: SkyDocsAnchorLinkService);
11
- transform(value: string, formatType?: SkyDocsAnchorLinkServiceFormatType): string;
12
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeAnchorLinksPipe, never>;
13
- static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsTypeAnchorLinksPipe, "skyDocsTypeAnchorLinks", false>;
14
- }
@@ -1,36 +0,0 @@
1
- import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
2
- import { SkyDocsIndexSignatureDefinition } from './index-signature-definition';
3
- import { SkyDocsInterfacePropertyDefinition } from './interface-property-definition';
4
- /**
5
- * Describes TypeScript types.
6
- */
7
- export interface SkyDocsTypeDefinition {
8
- /**
9
- * Used by method, function, and arrow function types.
10
- */
11
- callSignature?: SkyDocsCallSignatureDefinition;
12
- /**
13
- * Used for index signatures, e.g. `[_: string]: any`
14
- */
15
- indexSignature?: SkyDocsIndexSignatureDefinition;
16
- name?: string | number | boolean;
17
- type?: 'array' | 'intrinsic' | 'literal' | 'reference' | 'reflection' | 'typeParameter' | 'typeOperator' | 'union' | 'unknown';
18
- /**
19
- * Describes any type arguments, e.g. `<T, F>`.
20
- */
21
- typeArguments?: SkyDocsTypeDefinition[];
22
- /**
23
- * Used for type literals or inline interfaces, e.g. `route: { commands: any[] }`
24
- */
25
- typeLiteral?: {
26
- properties?: SkyDocsInterfacePropertyDefinition[];
27
- };
28
- /**
29
- * The types that compose a union type.
30
- */
31
- unionTypes?: SkyDocsTypeDefinition[];
32
- /**
33
- * The NPM package where the type is defined.
34
- */
35
- package?: string;
36
- }
@@ -1,55 +0,0 @@
1
- import { SkyDocsClassPropertyDefinition } from './property-definition';
2
- import { SkyDocsInterfaceDefinition } from './interface-definition';
3
- import { SkyDocsClassMethodDefinition } from './method-definition';
4
- import { SkyDocsParameterDefinition } from './parameter-definition';
5
- import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
6
- import { SkyDocsTypeDefinition } from './type-definition';
7
- import * as i0 from "@angular/core";
8
- interface GetFormattedTypeConfig {
9
- escapeSpecialCharacters: boolean;
10
- }
11
- /**
12
- * Formats type definitions into HTML-compatible strings.
13
- */
14
- export declare class SkyDocsTypeDefinitionsFormatService {
15
- /**
16
- * Returns an HTML-formatted representation of the provided interface config.
17
- */
18
- getInterfaceSourceCode(definition: SkyDocsInterfaceDefinition): string;
19
- /**
20
- * Returns an HTML-formatted representation of the provided method config.
21
- */
22
- getMethodSourceCode(definition: SkyDocsClassMethodDefinition): string;
23
- /**
24
- * Returns an HTML-formatted representation of the provided type alias config.
25
- */
26
- getTypeAliasSourceCode(definition: SkyDocsTypeAliasDefinition): string;
27
- /**
28
- * Returns a formatted string representing a parameter's name and value. For example: `'foo: string'`.
29
- */
30
- getFormattedParameterName(parameter: SkyDocsParameterDefinition, config?: GetFormattedTypeConfig): string;
31
- /**
32
- * Returns a formatted string representing a property (or method's) name and value. For example: `'public foo: string'`.
33
- */
34
- getFormattedPropertyName(property: SkyDocsClassPropertyDefinition): string;
35
- /**
36
- * Returns an HTML-formatted method name to be used on the properties table.
37
- */
38
- getFormattedMethodName(definition: SkyDocsClassMethodDefinition): string;
39
- /**
40
- * Returns a formatted string representing the provided type.
41
- */
42
- getFormattedType(type: SkyDocsTypeDefinition, config?: GetFormattedTypeConfig): string;
43
- escapeSpecialCharacters(value: string): string;
44
- private getFormattedCallSignature;
45
- private getFormattedUnion;
46
- /**
47
- * Parse any type arguments e.g. `<T, F>`.
48
- */
49
- private getFormattedTypeArguments;
50
- private getFormattedTypeParameters;
51
- private getFormattedInterfaceProperties;
52
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsFormatService, never>;
53
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsFormatService>;
54
- }
55
- export {};
@@ -1,10 +0,0 @@
1
- import { TypeDocEntry } from './typedoc-types';
2
- import * as i0 from "@angular/core";
3
- export declare class SkyDocsTypeDefinitionsProvider {
4
- readonly anchorIds: {
5
- [_: string]: string;
6
- };
7
- readonly typeDefinitions: TypeDocEntry[];
8
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsProvider, never>;
9
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsProvider>;
10
- }
@@ -1,20 +0,0 @@
1
- import { SkyDocsClassDefinition } from './class-definition';
2
- import { SkyDocsDirectiveDefinition } from './directive-definition';
3
- import { SkyDocsEnumerationDefinition } from './enumeration-definition';
4
- import { SkyDocsInterfaceDefinition } from './interface-definition';
5
- import { SkyDocsPipeDefinition } from './pipe-definition';
6
- import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
7
- /**
8
- * @internal
9
- */
10
- export interface SkyDocsTypeDefinitions {
11
- classes: SkyDocsClassDefinition[];
12
- components: SkyDocsDirectiveDefinition[];
13
- directives: SkyDocsDirectiveDefinition[];
14
- enumerations: SkyDocsEnumerationDefinition[];
15
- hasPreviewFeatures: boolean;
16
- interfaces: SkyDocsInterfaceDefinition[];
17
- pipes: SkyDocsPipeDefinition[];
18
- services: SkyDocsClassDefinition[];
19
- typeAliases: SkyDocsTypeAliasDefinition[];
20
- }
@@ -1,26 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "./call-signature-definition.component";
3
- import * as i2 from "./class-definition.component";
4
- import * as i3 from "./directive-definition.component";
5
- import * as i4 from "./enumeration-definition.component";
6
- import * as i5 from "./interface-definition.component";
7
- import * as i6 from "./method-definitions.component";
8
- import * as i7 from "./pipe-definition.component";
9
- import * as i8 from "./property-definitions.component";
10
- import * as i9 from "./type-alias-definition.component";
11
- import * as i10 from "./type-anchor-links.pipe";
12
- import * as i11 from "@angular/common";
13
- import * as i12 from "@angular/router";
14
- import * as i13 from "@blackbaud/skyux-lib-code-block";
15
- import * as i14 from "@skyux/layout";
16
- import * as i15 from "../heading-anchor/heading-anchor.module";
17
- import * as i16 from "../markdown/markdown.module";
18
- import * as i17 from "./preview-feature-indicator.component";
19
- import * as i18 from "../safe-html/safe-html.module";
20
- import * as i19 from "@skyux/icon";
21
- import * as i20 from "@skyux/indicators";
22
- export declare class SkyDocsTypeDefinitionsModule {
23
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsModule, never>;
24
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsTypeDefinitionsModule, [typeof i1.SkyDocsCallSignatureDefinitionComponent, typeof i2.SkyDocsClassDefinitionComponent, typeof i3.SkyDocsDirectiveDefinitionComponent, typeof i4.SkyDocsEnumerationDefinitionComponent, typeof i5.SkyDocsInterfaceDefinitionComponent, typeof i6.SkyDocsMethodDefinitionsComponent, typeof i7.SkyDocsPipeDefinitionComponent, typeof i8.SkyDocsPropertyDefinitionsComponent, typeof i9.SkyDocsTypeAliasDefinitionComponent, typeof i10.SkyDocsTypeAnchorLinksPipe], [typeof i11.CommonModule, typeof i12.RouterModule, typeof i13.SkyCodeBlockModule, typeof i13.SkyCodeModule, typeof i14.SkyDefinitionListModule, typeof i15.SkyDocsHeadingAnchorModule, typeof i16.SkyDocsMarkdownModule, typeof i17.SkyDocsPreviewIndicatorComponent, typeof i18.SkyDocsSafeHtmlModule, typeof i19.SkyIconModule, typeof i20.SkyStatusIndicatorModule], [typeof i1.SkyDocsCallSignatureDefinitionComponent, typeof i2.SkyDocsClassDefinitionComponent, typeof i3.SkyDocsDirectiveDefinitionComponent, typeof i4.SkyDocsEnumerationDefinitionComponent, typeof i5.SkyDocsInterfaceDefinitionComponent, typeof i6.SkyDocsMethodDefinitionsComponent, typeof i7.SkyDocsPipeDefinitionComponent, typeof i8.SkyDocsPropertyDefinitionsComponent, typeof i9.SkyDocsTypeAliasDefinitionComponent, typeof i10.SkyDocsTypeAnchorLinksPipe]>;
25
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsTypeDefinitionsModule>;
26
- }
@@ -1,20 +0,0 @@
1
- import { SkyDocsTypeDefinitions } from './type-definitions';
2
- import { SkyDocsTypeDefinitionsProvider } from './type-definitions-provider';
3
- import { SkyDocsTypeDocAdapterService } from './typedoc-adapter.service';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Handles all type definitions that have been converted from the third-party documentation generator.
7
- */
8
- export declare class SkyDocsTypeDefinitionsService {
9
- private typeDefinitionsProvider;
10
- private adapter;
11
- constructor(typeDefinitionsProvider: SkyDocsTypeDefinitionsProvider, adapter: SkyDocsTypeDocAdapterService);
12
- /**
13
- * Returns type definitions from a specific source code location.
14
- * @param sourceCodePath The directory of the source code you wish to pull type definitions from,
15
- * relative to the application's root directory.
16
- */
17
- getTypeDefinitions(sourceCodePath: string, additionalSourceCodePaths?: string[]): SkyDocsTypeDefinitions;
18
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsService, never>;
19
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsService>;
20
- }
@@ -1,8 +0,0 @@
1
- import { SkyDocsTypeDefinition } from './type-definition';
2
- /**
3
- * Describes a type parameter, e.g. `<T>`.
4
- */
5
- export interface SkyDocsTypeParameterDefinition {
6
- name: string;
7
- type?: SkyDocsTypeDefinition;
8
- }
@@ -1,49 +0,0 @@
1
- import { SkyDocsClassDefinition } from './class-definition';
2
- import { SkyDocsDirectiveDefinition } from './directive-definition';
3
- import { SkyDocsEnumerationDefinition } from './enumeration-definition';
4
- import { SkyDocsInterfaceDefinition } from './interface-definition';
5
- import { SkyDocsPipeDefinition } from './pipe-definition';
6
- import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
7
- import { SkyDocsTypeDefinitionsProvider } from './type-definitions-provider';
8
- import { TypeDocEntry } from './typedoc-types';
9
- import * as i0 from "@angular/core";
10
- /**
11
- * Converts TypeDoc types into SKY UX docs-tools types, to be supplied to the various definitions components.
12
- */
13
- export declare class SkyDocsTypeDocAdapterService {
14
- #private;
15
- private typeDefinitionsProvider?;
16
- constructor(typeDefinitionsProvider?: SkyDocsTypeDefinitionsProvider);
17
- toClassDefinition(entry: TypeDocEntry): SkyDocsClassDefinition;
18
- toDirectiveDefinition(entry: TypeDocEntry): SkyDocsDirectiveDefinition;
19
- toEnumerationDefinition(entry: TypeDocEntry): SkyDocsEnumerationDefinition;
20
- toInterfaceDefinition(entry: TypeDocEntry): SkyDocsInterfaceDefinition;
21
- toPipeDefinition(entry: TypeDocEntry): SkyDocsPipeDefinition;
22
- toTypeAliasDefinition(entry: TypeDocEntry): SkyDocsTypeAliasDefinition;
23
- private getSelector;
24
- private getClassProperties;
25
- private getClassMethods;
26
- private getInterfaceProperties;
27
- private getEnumerationMembers;
28
- private getTypeDefinition;
29
- private getParameterDefinitions;
30
- private getTypeArgumentDefinitions;
31
- private getCallSignatureDefinition;
32
- private getIndexSignatureDefinition;
33
- private getTypeParameterDefinitions;
34
- private getCommentTags;
35
- /**
36
- * Parameter descriptions are derived from the parent's (function/method) comment.
37
- */
38
- private getParameterCommentTags;
39
- /**
40
- * Applies comment tag (e.g. `@param`) values to the provided definition, if the value is defined.
41
- */
42
- private applyCommentTagValues;
43
- private getDecorator;
44
- private getPropertyName;
45
- private getDefaultValue;
46
- private getAnchorId;
47
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDocAdapterService, [{ optional: true; }]>;
48
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDocAdapterService>;
49
- }
@@ -1,142 +0,0 @@
1
- export interface TypeDocComment {
2
- summary?: {
3
- kind: string;
4
- text: string;
5
- }[];
6
- blockTags?: {
7
- param?: string;
8
- content?: {
9
- kind: string;
10
- text: string;
11
- }[];
12
- tag: '@default' | '@defaultValue' | '@deprecated' | '@example' | '@param' | '@preview' | '@required';
13
- }[];
14
- }
15
- export interface TypeDocSource {
16
- fileName: string;
17
- }
18
- export interface TypeDocSignature {
19
- comment?: TypeDocComment;
20
- kind?: TypeDocKind.CallSignature | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature;
21
- name: string;
22
- parameters?: TypeDocParameter[];
23
- returnType?: TypeDocType;
24
- type?: TypeDocType;
25
- typeParameters?: TypeDocTypeParameter[];
26
- }
27
- export interface TypeDocTypeParameter {
28
- name: string;
29
- kind: TypeDocKind.TypeParameter;
30
- type?: TypeDocType;
31
- }
32
- export interface TypeDocType {
33
- constraint?: {
34
- name: string;
35
- };
36
- callSignature?: TypeDocSignature;
37
- declaration?: {
38
- children?: TypeDocEntryChild[];
39
- indexSignature?: TypeDocSignature;
40
- signatures?: TypeDocSignature[];
41
- };
42
- elementType?: TypeDocType;
43
- name?: string;
44
- operator?: 'keyof';
45
- target?: {
46
- name: string;
47
- };
48
- type?: 'array' | 'intrinsic' | 'literal' | 'reference' | 'reflection' | 'typeParameter' | 'typeOperator' | 'union' | 'unknown';
49
- typeArguments?: TypeDocType[];
50
- types?: TypeDocType[];
51
- value?: string;
52
- package?: string;
53
- }
54
- export interface TypeDocParameter {
55
- comment?: TypeDocComment;
56
- defaultValue?: string;
57
- kind: TypeDocKind.Parameter;
58
- name: string;
59
- type: TypeDocType;
60
- flags?: {
61
- isOptional?: boolean;
62
- };
63
- }
64
- export interface TypeDocEntryChild {
65
- comment?: TypeDocComment;
66
- decorators?: {
67
- arguments?: {
68
- bindingPropertyName?: string;
69
- };
70
- name: 'Input' | 'Output';
71
- type: TypeDocType;
72
- }[];
73
- defaultValue?: string;
74
- flags?: {
75
- isOptional?: boolean;
76
- isStatic?: boolean;
77
- };
78
- kind?: TypeDocKind.Accessor | TypeDocKind.CallSignature | TypeDocKind.Constructor | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature | TypeDocKind.EnumMember | TypeDocKind.Parameter | TypeDocKind.Property | TypeDocKind.Method;
79
- getSignature?: {
80
- comment: TypeDocComment;
81
- name: string;
82
- type: TypeDocType;
83
- };
84
- name?: string;
85
- setSignature?: {
86
- comment: TypeDocComment;
87
- name: string;
88
- parameters?: TypeDocParameter[];
89
- type: TypeDocType;
90
- };
91
- signatures?: TypeDocSignature[];
92
- sources?: TypeDocSource[];
93
- type?: TypeDocType;
94
- }
95
- export interface TypeDocEntry {
96
- anchorId?: string;
97
- children?: TypeDocEntryChild[];
98
- comment?: TypeDocComment;
99
- decorators?: {
100
- arguments?: {
101
- obj?: string;
102
- };
103
- name: 'Component' | 'Directive' | 'Injectable' | 'NgModule' | 'Pipe';
104
- type: TypeDocType;
105
- }[];
106
- kind?: TypeDocKind.Class | TypeDocKind.Enum | TypeDocKind.Interface | TypeDocKind.Reference | TypeDocKind.TypeAlias;
107
- indexSignature?: TypeDocSignature;
108
- name?: string;
109
- sources?: TypeDocSource[];
110
- type?: TypeDocType;
111
- typeParameters?: TypeDocTypeParameter[];
112
- }
113
- /**
114
- * This enum comes from:
115
- * https://github.com/TypeStrong/typedoc/blob/v0.25.13/src/lib/models/reflections/kind.ts
116
- * The enum is up to date as of version `0.25.13`.
117
- */
118
- export declare enum TypeDocKind {
119
- Project = 1,
120
- Module = 2,
121
- Namespace = 4,
122
- Enum = 8,
123
- EnumMember = 16,
124
- Variable = 32,
125
- Function = 64,
126
- Class = 128,
127
- Interface = 256,
128
- Constructor = 512,
129
- Property = 1024,
130
- Method = 2048,
131
- CallSignature = 4096,
132
- IndexSignature = 8192,
133
- ConstructorSignature = 16384,
134
- Parameter = 32768,
135
- TypeLiteral = 65536,
136
- TypeParameter = 131072,
137
- Accessor = 262144,
138
- GetSignature = 524288,
139
- SetSignature = 1048576,
140
- TypeAlias = 2097152,
141
- Reference = 4194304
142
- }