# render

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

function exported by @mwillbanks/tuil-ink.



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

## function [#function]

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

```ts
export async function render(
  app: TuilRuntime,
  options: TuilRenderOptions = {},
): Promise<TuilRenderInstance>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                | Required | Description                                          | Related types                                                               |
| --------- | ------------------- | -------- | ---------------------------------------------------- | --------------------------------------------------------------------------- |
| `app`     | `TuilRuntime`       | Yes      | Supplies the `app` value as `TuilRuntime`.           | [`TuilRuntime`](/tuil/docs/reference/packages/tuil/api/tuil-runtime)             |
| `options` | `TuilRenderOptions` | No       | Supplies the `options` value as `TuilRenderOptions`. | [`TuilRenderOptions`](/tuil/docs/reference/packages/ink/api/tuil-render-options) |

## Returns [#returns]

`Promise<TuilRenderInstance>` — Returns a value that satisfies `Promise<TuilRenderInstance>`.

Related types: [`TuilRenderInstance`](/tuil/docs/reference/packages/ink/api/tuil-render-instance)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TuilRenderInstance`](/tuil/docs/reference/packages/ink/api/tuil-render-instance)
* [`TuilRenderOptions`](/tuil/docs/reference/packages/ink/api/tuil-render-options)

## 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)