JavaScript 中怎么 Mock 剪贴板 Clipboard API

阿浩同学_7783

阿浩同学_7783

2026-10-06

578人浏览

原创

javascript单元测试中mock clipboard api需替换navigator.clipboard为可控promise对象:在beforeeach中赋值mock方法并还原,兼容node环境需手动挂载,覆盖permissiondenied等错误场景,并确保secure context。

javascript 中怎么 mock 剪贴板 clipboard api

在 JavaScript 单元测试中 Mock Clipboard API,核心是替换全局的 navigator.clipboard 对象,使其返回可控的 Promise 行为,从而避免真实读写系统剪贴板。

手动替换 navigator.clipboard(适用于 Jest / Vitest)

最直接的方式是在测试前临时覆盖 navigator.clipboard,模拟 writeText、readText 等方法的返回值:

  • 用 jest.mock() 或直接赋值方式劫持 navigator.clipboard
  • 确保 mock 方法返回 Promise.resolve() 或 Promise.reject(),匹配真实 API 的异步行为
  • 注意:需在测试运行前设置,且建议在 beforeEach 中还原,防止污染其他测试

示例(Jest):

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
beforeEach(() => {
  Object.assign(navigator, {
    clipboard: {
      writeText: jest.fn().mockResolvedValue(),
      readText: jest.fn().mockResolvedValue('mocked text'),
    },
  });
});

afterEach(() => {
  jest.clearAllMocks();
});

使用 Clipboard API 的 polyfill 或测试专用库

某些测试环境(如 Node.js)不支持 navigator.clipboard,可借助轻量工具增强兼容性:

  • clipboard-polyfill 提供一致接口,可在测试中安全导入并 mock
  • Vitest 用户可配合 vi.mock 模拟整个模块导出,更易控制内部逻辑
  • 避免直接依赖浏览器全局对象,把 Clipboard 调用封装成可注入的服务,测试时传入 mock 实现

处理权限与拒绝场景

真实 Clipboard API 可能因权限被拒而抛错(如 "NotAllowedError"),Mock 时需覆盖这些边界情况:

  • 让 writeText 返回 Promise.reject(new DOMException('Permission denied', 'NotAllowedError'))
  • 验证组件是否正确捕获错误、显示提示或降级处理
  • 注意不同浏览器对 readText 的权限要求更高,mock 时尤其要区分读/写行为

注意上下文安全性(Secure Context)限制

Clipboard API 只在 secure context(HTTPS 或 localhost)中可用。测试中若遇到 undefined,可能因环境不满足条件:

  • Jest 默认运行在 Node 环境,navigator.clipboard 本就不存在,必须手动挂载
  • Vitest 在浏览器模式下仍需确保测试页面以 http://localhost 启动(而非 file://)
  • 推荐统一通过 Object.defineProperty 安全挂载,避免报错:
if (!navigator.clipboard) {
  Object.defineProperty(navigator, 'clipboard', {
    value: { writeText: jest.fn().mockResolvedValue() },
    writable: true,
  });
}

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4546

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1129

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4464

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1796

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4233

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2740

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习