# mountTuilGhostty

Source: /tuil/docs/reference/packages/ghostty-web/api/mount-tuil-ghostty
Locale: en

function exported by @mwillbanks/tuil-ghostty-web.



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

## function [#function]

Public function exported by `@mwillbanks/tuil-ghostty-web`.

```ts
export async function mountTuilGhostty(
  options: TuilGhosttyMountOptions,
): Promise<TuilGhosttyInstance>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                      | Required | Description                                                | Related types                                                                                    |
| --------- | ------------------------- | -------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `options` | `TuilGhosttyMountOptions` | Yes      | Supplies the `options` value as `TuilGhosttyMountOptions`. | [`TuilGhosttyMountOptions`](/tuil/docs/reference/packages/ghostty-web/api/tuil-ghostty-mount-options) |

## Returns [#returns]

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

Related types: [`TuilGhosttyInstance`](/tuil/docs/reference/packages/ghostty-web/api/tuil-ghostty-instance)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TuilGhosttyInstance`](/tuil/docs/reference/packages/ghostty-web/api/tuil-ghostty-instance)
* [`TuilGhosttyMountOptions`](/tuil/docs/reference/packages/ghostty-web/api/tuil-ghostty-mount-options)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ghostty-web/src/browser.tsx)

## Package [#package]

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