TuilTestInstance
interface exported by @mwillbanks/tuil-testing-ink.
interface
Public interface exported by @mwillbanks/tuil-testing-ink.
export interface TuilTestInstance {
readonly app: TuilApp;
readonly ready: Promise<void>;
readonly screen: SemanticScreen;
readonly user: TuilUser;
readonly frames: readonly string[];
rerender(component: ReactElement): void;
resize(width: number, height?: number): void;
cleanup(): Promise<void>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
app | TuilApp<Record<string, unknown>, import("@mwillbanks/tuil-events").EventMap, import("@mwillbanks/tuil").TuilExtensionPoints> | Yes | The app member uses the TuilApp<Record<string, unknown>, import("@mwillbanks/tuil-events").EventMap, import("@mwillbanks/tuil").TuilExtensionPoints> contract. | EventMap, TuilExtensionPoints |
ready | Promise<void> | Yes | The ready member uses the Promise<void> contract. | — |
screen | SemanticScreen | Yes | The screen member uses the SemanticScreen contract. | SemanticScreen |
user | TuilUser | Yes | The user member uses the TuilUser contract. | TuilUser |
frames | readonly string[] | Yes | The frames member uses the readonly string[] contract. | — |
rerender | (component: ReactElement) => void | Yes | The rerender member uses the (component: ReactElement) => void contract. | — |
resize | (width: number, height?: number) => void | Yes | The resize member uses the (width: number, height?: number) => void contract. | — |
cleanup | () => Promise<void> | Yes | The cleanup member uses the () => Promise<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