StaticStoryRequest
interface exported by @mwillbanks/tuil-story.
interface
Public interface exported by @mwillbanks/tuil-story.
export interface StaticStoryRequest {
readonly storyId: string;
readonly variant: string;
readonly args?: Readonly<Record<string, unknown>>;
readonly controls?: Partial<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. | — |
args | Readonly<Record<string, unknown>> | undefined | No | The args member uses the Readonly<Record<string, unknown>> | undefined contract. | — |
controls | Partial<TerminalStoryControls> | undefined | No | The controls member uses the Partial<TerminalStoryControls> | undefined 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