# EditorBackend

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

interface exported by @mwillbanks/tuil-editor.



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

## interface [#interface]

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

```ts
export interface EditorBackend {
  readonly id: string;
  readonly version: string;
  readonly capabilities: ReadonlySet<EditorCapability>;
  create(options: EditorProviderOptions): EditorSession;
}
```

## Members [#members]

| Member         | Type                                                | Required | Description                                                                                | Related types                                                                                                                                                 |
| -------------- | --------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`           | `string`                                            | Yes      | The `id` member uses the `string` contract.                                                | —                                                                                                                                                             |
| `version`      | `string`                                            | Yes      | The `version` member uses the `string` contract.                                           | —                                                                                                                                                             |
| `capabilities` | `ReadonlySet<EditorCapability>`                     | Yes      | The `capabilities` member uses the `ReadonlySet<EditorCapability>` contract.               | [`EditorCapability`](/tuil/docs/reference/packages/editor/api/editor-capability)                                                                                   |
| `create`       | `(options: EditorProviderOptions) => EditorSession` | Yes      | The `create` member uses the `(options: EditorProviderOptions) => EditorSession` contract. | [`EditorProviderOptions`](/tuil/docs/reference/packages/editor/api/editor-provider-options), [`EditorSession`](/tuil/docs/reference/packages/editor/api/editor-session) |

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

* [`EditorCapability`](/tuil/docs/reference/packages/editor/api/editor-capability)
* [`EditorProviderOptions`](/tuil/docs/reference/packages/editor/api/editor-provider-options)
* [`EditorSession`](/tuil/docs/reference/packages/editor/api/editor-session)

## Source [#source]

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

## Package [#package]

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