# TuilTestInstance

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

interface exported by @mwillbanks/tuil-testing-ink.



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

## interface [#interface]

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

```ts
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 [#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`](/tuil/docs/reference/packages/events/api/event-map), [`TuilExtensionPoints`](/tuil/docs/reference/packages/tuil/api/tuil-extension-points) |
| `ready`    | `Promise<void>`                                                                                                                | Yes      | The `ready` member uses the `Promise<void>` contract.                                                                                                              | —                                                                                                                                             |
| `screen`   | `SemanticScreen`                                                                                                               | Yes      | The `screen` member uses the `SemanticScreen` contract.                                                                                                            | [`SemanticScreen`](/tuil/docs/reference/packages/testing-ink/api/semantic-screen)                                                                  |
| `user`     | `TuilUser`                                                                                                                     | Yes      | The `user` member uses the `TuilUser` contract.                                                                                                                    | [`TuilUser`](/tuil/docs/reference/packages/testing-ink/api/tuil-user)                                                                              |
| `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 [#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]

* [`SemanticScreen`](/tuil/docs/reference/packages/testing-ink/api/semantic-screen)
* [`TuilUser`](/tuil/docs/reference/packages/testing-ink/api/tuil-user)

## Source [#source]

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

## Package [#package]

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