chore(window): 完善copyText方法的JsDoc @example

renzp94 · Apr 23, 2024 · a1dbcc9 · a1dbcc9
1 parent 2efe697
commit a1dbcc9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/window.ts b/src/window.ts
@@ -5,6 +5,11 @@
  *
  * @param text 要复制的文本
  * @returns 如果复制成功则返回true，否则返回false
+ *
+ * @example
+ * const status = await copyText('复制文本'); // true
+ * const text = await navigator.clipboard.readText();
+ * console.log(text); // 复制文本
  */
 export const copyText = async (text: string) => {
   try {