# TerminalStoryFrameEffectOptions

Source: /tuil/docs/reference/packages/story/api/terminal-story-frame-effect-options
Locale: en

interface exported by @mwillbanks/tuil-story.



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

## interface [#interface]

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

```ts
export interface TerminalStoryFrameEffectOptions {
  readonly endpoint: string;
  readonly body: string;
  readonly setFrame: (frame: StoryFrame | undefined) => void;
  readonly setStatus: (status: string) => void;
}
```

## Members [#members]

| Member      | Type                                       | Required | Description                                                                         | Related types                                                  |
| ----------- | ------------------------------------------ | -------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `endpoint`  | `string`                                   | Yes      | The `endpoint` member uses the `string` contract.                                   | —                                                              |
| `body`      | `string`                                   | Yes      | The `body` member uses the `string` contract.                                       | —                                                              |
| `setFrame`  | `(frame: StoryFrame \| undefined) => void` | Yes      | The `setFrame` member uses the `(frame: StoryFrame \| undefined) => void` contract. | [`StoryFrame`](/tuil/docs/reference/packages/story/api/story-frame) |
| `setStatus` | `(status: string) => void`                 | Yes      | The `setStatus` member uses the `(status: string) => void` contract.                | —                                                              |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`StoryFrame`](/tuil/docs/reference/packages/story/api/story-frame)

## 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)