Add indexer API docs

storybookjs · Jun 9, 2024 · a57e45c · a57e45c
1 parent c69d536
commit a57e45c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/code/lib/types/src/modules/indexer.ts b/code/lib/types/src/modules/indexer.ts
@@ -93,7 +93,7 @@ export type IndexEntry = StoryIndexEntry | DocsIndexEntry;
 export type BaseIndexInput = {
   /** The file to import from e.g. the story file. */
   importPath: Path;
-  /** The raw path/package to the file that provides meta.component, if one exists */
+  /** The raw path/package of the file that provides meta.component, if one exists */
   rawComponentPath?: Path;
   /** The name of the export to import. */
   exportName: ExportName;

diff --git a/docs/api/main-config-indexers.md b/docs/api/main-config-indexers.md
@@ -97,6 +97,7 @@ Type:
   exportName: string;
   importPath: string;
   type: 'story';
+  rawComponentPath?: string;
   metaId?: string;
   name?: string;
   tags?: string[];
@@ -133,6 +134,12 @@ Type: `'story'`
 
 The type of entry.
 
+##### `rawComponentPath`
+
+Type: `string`
+
+The raw path/package of the file that provides `meta.component`, if one exists.
+
 ##### `metaId`
 
 Type: `string`