expose svelte2tsx component documentation

sveltejs · Jan 27, 2022 · 7bb4385 · 7bb4385
1 parent cad755f
commit 7bb4385
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/packages/svelte2tsx/index.d.ts b/packages/svelte2tsx/index.d.ts
@@ -3,11 +3,24 @@ export interface SvelteCompiledToTsx {
     map: import("magic-string").SourceMap;
     exportedNames: IExportedNames;
     events: ComponentEvents;
+    componentDocumentation: string;
+    slots: Map<string, Map<string, string>>;
+    generics: {
+        definitions: string[];
+        references: string[];
+    };
 }
 
-export interface IExportedNames {
-    has(name: string): boolean;
-}
+export type IExportedNames = Map<
+    string,
+    {
+        isLet: boolean;
+        type?: string;
+        identifierText?: string;
+        required?: boolean;
+        doc?: string;
+    }
+>;
 
 export interface ComponentEvents {
     getAll(): { name: string; type: string; doc?: string }[];

diff --git a/packages/svelte2tsx/src/svelte2tsx/index.ts b/packages/svelte2tsx/src/svelte2tsx/index.ts
@@ -451,7 +451,13 @@ declare function __sveltets_1_createSvelteComponentTyped<Props, Events, Slots>(
             code: str.toString(),
             map: str.generateMap({ hires: true, source: options?.filename }),
             exportedNames: exportedNames.getExportsMap(),
-            events: events.createAPI()
+            events: events.createAPI(),
+            componentDocumentation: componentDocumentation.getFormatted(),
+            slots,
+            generics: {
+                definition: generics.toDefinitionString(),
+                references: generics.toReferencesString()
+            }
         };
     }
 }