clipboard.d.ts 687 B

12345678910111213141516171819202122232425
  1. /**
  2. * Writes plain text to the clipboard.
  3. * @example
  4. * ```typescript
  5. * import { writeText, readText } from '@tauri-apps/api/clipboard';
  6. * await writeText('Tauri is awesome!');
  7. * assert(await readText(), 'Tauri is awesome!');
  8. * ```
  9. *
  10. * @returns A promise indicating the success or failure of the operation.
  11. *
  12. * @since 1.0.0.
  13. */
  14. declare function writeText(text: string): Promise<void>;
  15. /**
  16. * Gets the clipboard content as plain text.
  17. * @example
  18. * ```typescript
  19. * import { readText } from '@tauri-apps/api/clipboard';
  20. * const clipboardText = await readText();
  21. * ```
  22. * @since 1.0.0.
  23. */
  24. declare function readText(): Promise<string | null>;
  25. export { writeText, readText };