123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116 |
- export interface JsonDocs {
- components: JsonDocsComponent[];
- timestamp: string;
- compiler: {
- name: string;
- version: string;
- typescriptVersion: string;
- };
- }
- export interface JsonDocsComponent {
- dirPath?: string;
- fileName?: string;
- filePath?: string;
- readmePath?: string;
- usagesDir?: string;
- encapsulation: 'shadow' | 'scoped' | 'none';
- tag: string;
- readme: string;
- docs: string;
- docsTags: JsonDocsTag[];
- usage: JsonDocsUsage;
- props: JsonDocsProp[];
- methods: JsonDocsMethod[];
- events: JsonDocsEvent[];
- listeners: JsonDocsListener[];
- styles: JsonDocsStyle[];
- slots: JsonDocsSlot[];
- parts: JsonDocsPart[];
- dependents: string[];
- dependencies: string[];
- dependencyGraph: JsonDocsDependencyGraph;
- deprecation?: string;
- }
- export interface JsonDocsDependencyGraph {
- [tagName: string]: string[];
- }
- export interface JsonDocsTag {
- name: string;
- text?: string;
- }
- export interface JsonDocsValue {
- value?: string;
- type: string;
- }
- export interface JsonDocsUsage {
- [key: string]: string;
- }
- export interface JsonDocsProp {
- name: string;
- type: string;
- mutable: boolean;
- /**
- * The name of the attribute that is exposed to configure a compiled web component
- */
- attr?: string;
- reflectToAttr: boolean;
- docs: string;
- docsTags: JsonDocsTag[];
- default: string;
- deprecation?: string;
- values: JsonDocsValue[];
- optional: boolean;
- required: boolean;
- }
- export interface JsonDocsMethod {
- name: string;
- docs: string;
- docsTags: JsonDocsTag[];
- deprecation?: string;
- signature: string;
- returns: JsonDocsMethodReturn;
- parameters: JsonDocMethodParameter[];
- }
- export interface JsonDocsMethodReturn {
- type: string;
- docs: string;
- }
- export interface JsonDocMethodParameter {
- name: string;
- type: string;
- docs: string;
- }
- export interface JsonDocsEvent {
- event: string;
- bubbles: boolean;
- cancelable: boolean;
- composed: boolean;
- docs: string;
- docsTags: JsonDocsTag[];
- deprecation?: string;
- detail: string;
- }
- export interface JsonDocsStyle {
- name: string;
- docs: string;
- annotation: string;
- }
- export interface JsonDocsListener {
- event: string;
- target?: string;
- capture: boolean;
- passive: boolean;
- }
- export interface JsonDocsSlot {
- name: string;
- docs: string;
- }
- export interface JsonDocsPart {
- name: string;
- docs: string;
- }
- export interface StyleDoc {
- name: string;
- docs: string;
- annotation: 'prop';
- }
|