# renderStoryRequest

Source: /tuil/docs/reference/packages/story/api/render-story-request
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 renderStoryRequest(
  catalog: TuilStoryCatalog,
  request: StoryBridgeRequest,
  options: {
    readonly themeRegistry?: ThemeRegistry;
    readonly signal?: AbortSignal;
  } = {},
): Promise<StoryFrame>;
```

## 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)     |
| `request` | `StoryBridgeRequest`                                                                             | Yes      | Supplies the `request` value as `StoryBridgeRequest`.                                                                             | [`StoryBridgeRequest`](/tuil/docs/reference/packages/story/api/story-bridge-request) |
| `options` | `&#123;     readonly themeRegistry?: ThemeRegistry;     readonly signal?: AbortSignal;   &#125;` | No       | Supplies the `options` value as `&#123;     readonly themeRegistry?: ThemeRegistry;     readonly signal?: AbortSignal;   &#125;`. | [`ThemeRegistry`](/tuil/docs/reference/packages/theme/api/theme-registry)            |

## Returns [#returns]

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

Related types: [`StoryFrame`](/tuil/docs/reference/packages/story/api/story-frame)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`StoryBridgeRequest`](/tuil/docs/reference/packages/story/api/story-bridge-request)
* [`StoryFrame`](/tuil/docs/reference/packages/story/api/story-frame)
* [`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)