docs(clipboard): Remove readHtml mention

tauri-apps · Dec 9, 2024 · eb94dda · eb94dda
1 parent 6fcb2f5
commit eb94dda
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/plugins/clipboard-manager/README.md b/plugins/clipboard-manager/README.md
@@ -72,7 +72,6 @@ import {
   writeText,
   readText,
   writeHtml,
-  readHtml,
   clear
 } from '@tauri-apps/plugin-clipboard-manager'
 await writeText('Tauri is awesome!')

diff --git a/plugins/clipboard-manager/guest-js/index.ts b/plugins/clipboard-manager/guest-js/index.ts
@@ -111,9 +111,11 @@ async function readImage(): Promise<Image> {
  *
  * @example
  * ```typescript
- * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * import { writeHtml } from '@tauri-apps/plugin-clipboard-manager';
  * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
- * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * // The following will write "<h1>Tauri is awesome</h1>" as plain text
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>');
+ * // we can read html data only as a string so there's just readText(), no readHtml()
  * assert(await readText(), '<h1>Tauri is awesome!</h1>');
  * ```
  *