TerminalStoryFrameEffectOptions
interface exported by @mwillbanks/tuil-story.
interface
Public interface exported by @mwillbanks/tuil-story.
export interface TerminalStoryFrameEffectOptions {
readonly endpoint: string;
readonly body: string;
readonly setFrame: (frame: StoryFrame | undefined) => void;
readonly setStatus: (status: string) => void;
}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 |
setStatus | (status: string) => void | Yes | The setStatus member uses the (status: string) => void contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference