# TuilRenderInstance

Source: /tuil/docs/reference/packages/ink/api/tuil-render-instance
Locale: en

interface exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-ink`.

```ts
export interface TuilRenderInstance {
  readonly ink?: Instance;
  readonly app: TuilRuntime;
  waitUntilExit(): Promise<void>;
  unmount(): Promise<void>;
}
```

## Members [#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`](/tuil/docs/reference/packages/events/api/event-map), [`TuilExtensionPoints`](/tuil/docs/reference/packages/tuil/api/tuil-extension-points), [`TuilRuntime`](/tuil/docs/reference/packages/tuil/api/tuil-runtime) |
| `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 [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)