TuilRenderInstance
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface TuilRenderInstance {
readonly ink?: Instance;
readonly app: TuilRuntime;
waitUntilExit(): Promise<void>;
unmount(): Promise<void>;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
ink | Instance | undefined | No | The ink member uses the Instance | undefined contract. | — |
app | TuilRuntime<import("@mwillbanks/tuil-events").EventMap, import("@mwillbanks/tuil").TuilExtensionPoints> | Yes | The app member uses the TuilRuntime<import("@mwillbanks/tuil-events").EventMap, import("@mwillbanks/tuil").TuilExtensionPoints> contract. | EventMap, TuilExtensionPoints, TuilRuntime |
waitUntilExit | () => Promise<void> | Yes | The waitUntilExit member uses the () => Promise<void> contract. | — |
unmount | () => Promise<void> | Yes | The unmount 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
No package-local related types.
Source
View the secondary source reference