function
convertLexicalToPlaintext
A document's text without formatting, for previews, search, notifications or a language model. Blocks are separated by a blank line, list items are on their own lines, and a line break is a newline. Pure and synchronous, like renderRichTextHTML.
Arguments
| Argument | Type | Description |
|---|---|---|
value | RichTextDocument< | A stored rich-text document. |
options | RichTextPlaintextOptions< | Text for custom blocks, uploads and relationships, which are left out without it. |
Returns
The declared result.
stringFull signature
function convertLexicalToPlaintext<Payload extends {
blockType: string
} = never>(
value: RichTextDocument<Payload>,
options?: RichTextPlaintextOptions<Payload>,
): stringRelated types
RichTextDocumentThe portable TypeScript contract for stored version-1 rich text.
RichTextPlaintextOptionsText for the nodes
convertLexicalToPlaintextcan't read text from, such as custom blocks.