renderStoryRequest

function

Public function exported by @mwillbanks/tuil-story.

export async function renderStoryRequest(
  catalog: TuilStoryCatalog,
  request: StoryBridgeRequest,
  options: {
    readonly themeRegistry?: ThemeRegistry;
    readonly signal?: AbortSignal;
  } = {},
): Promise<StoryFrame>;

Members

This declaration has no public members.

Parameters

Member	Type	Required	Description	Related types
`catalog`	`TuilStoryCatalog`	Yes	Supplies the `catalog` value as `TuilStoryCatalog`.	`TuilStoryCatalog`
`request`	`StoryBridgeRequest`	Yes	Supplies the `request` value as `StoryBridgeRequest`.	`StoryBridgeRequest`
`options`	`{ readonly themeRegistry?: ThemeRegistry; readonly signal?: AbortSignal; }`	No	Supplies the `options` value as `{ readonly themeRegistry?: ThemeRegistry; readonly signal?: AbortSignal; }`.	`ThemeRegistry`

Returns

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

Related types: StoryFrame

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-story

renderStoryRequest

On this page