# createTerminalStoryFrameEffect

Source: /tuil/docs/reference/packages/story/api/create-terminal-story-frame-effect
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 function createTerminalStoryFrameEffect({
  endpoint,
  body,
  setFrame,
  setStatus,
}: TerminalStoryFrameEffectOptions): () => () => void;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                       | Type                              | Required | Description                                                                                                           | Related types                                                                                               |
| ------------------------------------------------------------ | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `{   endpoint,   body,   setFrame,   setStatus, }` | `TerminalStoryFrameEffectOptions` | Yes      | Supplies the `{   endpoint,   body,   setFrame,   setStatus, }` value as `TerminalStoryFrameEffectOptions`. | [`TerminalStoryFrameEffectOptions`](/tuil/docs/reference/packages/story/api/terminal-story-frame-effect-options) |

## Returns [#returns]

`() => () => void` — Returns a value that satisfies `() => () => void`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalStoryFrameEffectOptions`](/tuil/docs/reference/packages/story/api/terminal-story-frame-effect-options)

## Source [#source]

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

## Package [#package]

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