TerminalStoryControls
interface exported by @mwillbanks/tuil-testing.
interface
Public interface exported by @mwillbanks/tuil-testing.
export interface TerminalStoryControls {
readonly width: number;
readonly height: number;
readonly colorDepth: 1 | 4 | 8 | 24;
readonly unicode: boolean;
readonly theme: string;
readonly platform: NodeJS.Platform;
readonly interactive: boolean;
readonly reducedMotion: boolean;
readonly mouse: boolean;
readonly hyperlinks: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
width | number | Yes | The width member uses the number contract. | — |
height | number | Yes | The height member uses the number contract. | — |
colorDepth | 1 | 4 | 8 | 24 | Yes | The colorDepth member uses the 1 | 4 | 8 | 24 contract. | — |
unicode | boolean | Yes | The unicode member uses the boolean contract. | — |
theme | string | Yes | The theme member uses the string contract. | — |
platform | NodeJS.Platform | Yes | The platform member uses the NodeJS.Platform contract. | — |
interactive | boolean | Yes | The interactive member uses the boolean contract. | — |
reducedMotion | boolean | Yes | The reducedMotion member uses the boolean contract. | — |
mouse | boolean | Yes | The mouse member uses the boolean contract. | — |
hyperlinks | boolean | Yes | The hyperlinks member uses the boolean 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
No package-local related types.
Source
View the secondary source reference