# insertText

Source: /tuil/docs/reference/packages/editor/api/insert-text
Locale: en

function exported by @mwillbanks/tuil-editor.



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

## function [#function]

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

```ts
export function insertText(
  session: EditorSession,
  value: string,
): EditorSnapshot;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type            | Required | Description                                      | Related types                                                         |
| --------- | --------------- | -------- | ------------------------------------------------ | --------------------------------------------------------------------- |
| `session` | `EditorSession` | Yes      | Supplies the `session` value as `EditorSession`. | [`EditorSession`](/tuil/docs/reference/packages/editor/api/editor-session) |
| `value`   | `string`        | Yes      | Supplies the `value` value as `string`.          | —                                                                     |

## Returns [#returns]

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

Related types: [`EditorSnapshot`](/tuil/docs/reference/packages/editor/api/editor-snapshot)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`EditorSession`](/tuil/docs/reference/packages/editor/api/editor-session)
* [`EditorSnapshot`](/tuil/docs/reference/packages/editor/api/editor-snapshot)

## Source [#source]

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

## Package [#package]

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