# createTuilGhosttyDocumentSession

Source: /tuil/docs/reference/packages/ghostty-web/api/create-tuil-ghostty-document-session
Locale: en

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



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

## export [#export]

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

```ts
export function createTuilGhosttyDocumentSession(
  initialDocument: PlaygroundDocumentV1,
): TuilGhosttyDocumentSession;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member            | Type                   | Required | Description                                                     | Related types                                                                             |
| ----------------- | ---------------------- | -------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `initialDocument` | `PlaygroundDocumentV1` | Yes      | Supplies the `initialDocument` value as `PlaygroundDocumentV1`. | [`PlaygroundDocumentV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-document-v1) |

## Returns [#returns]

`TuilGhosttyDocumentSession` — Returns a value that satisfies `TuilGhosttyDocumentSession`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`PlaygroundDocumentV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-document-v1)

## Source [#source]

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

## Package [#package]

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