generateStoryCatalogDocumentation
function exported by @mwillbanks/tuil-story.
function
Public function exported by @mwillbanks/tuil-story.
export async function generateStoryCatalogDocumentation(
catalog: TuilStoryCatalog,
options: {
readonly themeRegistry?: ThemeRegistry;
readonly signal?: AbortSignal;
readonly maxStories?: number;
} = {},
): Promise<Readonly<Record<string, string>>>;Members
This declaration has no public members.
Parameters
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
catalog | TuilStoryCatalog | Yes | Supplies the catalog value as TuilStoryCatalog. | TuilStoryCatalog |
options | { readonly themeRegistry?: ThemeRegistry; readonly signal?: AbortSignal; readonly maxStories?: number; } | No | Supplies the options value as { readonly themeRegistry?: ThemeRegistry; readonly signal?: AbortSignal; readonly maxStories?: number; }. | ThemeRegistry |
Returns
Promise<Readonly<Record<string, string>>> — Returns a value that satisfies Promise<Readonly<Record<string, string>>>.
Related types: —
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference