# generateStoryCatalogSnapshots

Source: /tuil/docs/reference/packages/story/api/generate-story-catalog-snapshots
Locale: en

function exported by @mwillbanks/tuil-story.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-story`.

```ts
export async function generateStoryCatalogSnapshots(
  catalog: TuilStoryCatalog,
  options: {
    readonly themeRegistry?: ThemeRegistry;
    readonly signal?: AbortSignal;
    readonly maxStories?: number;
  } = {},
): Promise<StoryCatalogSnapshots>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                                                                                                                               | Required | Description                                                                                                                                                         | Related types                                                               |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `catalog` | `TuilStoryCatalog`                                                                                                                 | Yes      | Supplies the `catalog` value as `TuilStoryCatalog`.                                                                                                                 | [`TuilStoryCatalog`](/tuil/docs/reference/packages/story/api/tuil-story-catalog) |
| `options` | `&#123;     readonly themeRegistry?: ThemeRegistry;     readonly signal?: AbortSignal;     readonly maxStories?: number;   &#125;` | No       | Supplies the `options` value as `&#123;     readonly themeRegistry?: ThemeRegistry;     readonly signal?: AbortSignal;     readonly maxStories?: number;   &#125;`. | [`ThemeRegistry`](/tuil/docs/reference/packages/theme/api/theme-registry)        |

## Returns [#returns]

`Promise<StoryCatalogSnapshots>` — Returns a value that satisfies `Promise<StoryCatalogSnapshots>`.

Related types: [`StoryCatalogSnapshots`](/tuil/docs/reference/packages/story/api/story-catalog-snapshots)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`StoryCatalogSnapshots`](/tuil/docs/reference/packages/story/api/story-catalog-snapshots)
* [`TuilStoryCatalog`](/tuil/docs/reference/packages/story/api/tuil-story-catalog)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/story/src/index.tsx)

## Package [#package]

[@mwillbanks/tuil-story](/tuil/docs/reference/packages/story)