StorySnapshot
interface exported by @mwillbanks/tuil-story.
interface
Public interface exported by @mwillbanks/tuil-story.
export interface StorySnapshot {
readonly storyId: string;
readonly variant: string;
readonly frame: string;
readonly ansiFrame: string;
readonly semantics: readonly QueryableSemanticNode[];
readonly focus: StoryFrame["focus"];
readonly controls: TerminalStoryControls;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
storyId | string | Yes | The storyId member uses the string contract. | — |
variant | string | Yes | The variant member uses the string contract. | — |
frame | string | Yes | The frame member uses the string contract. | — |
ansiFrame | string | Yes | The ansiFrame member uses the string contract. | — |
semantics | readonly QueryableSemanticNode[] | Yes | The semantics member uses the readonly QueryableSemanticNode[] contract. | QueryableSemanticNode |
focus | { readonly focusedId?: string; readonly nodes: readonly { readonly id: string; readonly label?: string; readonly role?: string; }[]; } | Yes | The focus member uses the { readonly focusedId?: string; readonly nodes: readonly { readonly id: string; readonly label?: string; readonly role?: string; }[]; } contract. | — |
controls | TerminalStoryControls | Yes | The controls member uses the TerminalStoryControls contract. | TerminalStoryControls |
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