# @forbeslindesay/jsdom 中文文档 规范地址：https://npmcn.com/package/%40forbeslindesay/jsdom/ 版本：11\.1\.9 npm 元数据更新时间：2022-06-12T18:02:48.889Z 中文译文更新时间：2026-11-15T17:44:37.089Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40forbeslindesay/jsdom 原文对照：https://npmcn.com/package/%40forbeslindesay/jsdom/?lang=original 项目主页：https://github.com/tmpvar/jsdom#readme 源码仓库：https://github.com/tmpvar/jsdom ## 关键信息（来自 npm 元数据） - 模块格式：CommonJS - TypeScript 类型：未声明 - 运行依赖：21 个 - 首次发布：2017-07-07T08:11:54.539Z - 最新版本发布：2017-07-09T01:41:30.879Z - 近 30 天下载量：2018（2026-10-16 至 2026-11-14，npm 官方下载统计） - 已发布版本数：10（近 12 个月 0 个） ## 中文简介 JavaScript 许多网络标准的执行 ## 安装 ```sh npm install @forbeslindesay/jsdom ``` 也可以使用：`pnpm add @forbeslindesay/jsdom`、`yarn add @forbeslindesay/jsdom`、`bun add @forbeslindesay/jsdom` ## README # 日记 jsdom是许多网络标准的纯Java脚本执行,尤其是WHWG [管理部](https://dom.spec.whatwg.org/) 财务报告和审定财务报表 [HTML 语言](https://html.spec.whatwg.org/multipage/) 标准,与Node.js一起使用. 一般来说,该项目的目标是模仿足够多的网络浏览器子集,用于测试和刮去真实世界的网络应用. Jsdom的最新版本需要Node.js v6或更新. (v10下方的jsdom版本仍然与Node.js v4合作,但并不支持 截至v10,jsdom有一个新的API(下面记载). 原有的API目前仍然得到支持; [见文件](https://npmcn.com/package/%40forbeslindesay/jsdom/lib/old-api.md) 详细情况. ## 基本用途 ```js const jsdom = require("jsdom"); const { JSDOM } = jsdom; ``` 要使用jsdom, 您将主要使用 `JSDOM` 构造器,是 jsdom 主模块的命名导出 。 传出构造器一串. 你会回来的 `JSDOM` 对象,它具有一些有用的属性,特别是 `window`数字 : ```js const dom = new JSDOM(`

Hello world

`); console.log(dom.window.document.querySelector("p").textContent); // "Hello world" ``` (注意jsdom将解析您通过的HTML,就像浏览器一样,包括隐含的) ``, (中文(简体) ), ``,以及 `` 标记。 ) 生成的对象是 `JSDOM` 类,其中包含若干有用的属性和方法,除此之外 `window`。一般来说,它可以用来从“外部”来进行jsdom, 做一些与普通的DOM API不可能做的事情。 对于简单的案例,如果您不需要任何这种功能,我们建议一个编码模式,比如: ```js const { window } = new JSDOM(`...`); // or even const { document } = (new JSDOM(`...`)).window; ``` 关于你所能做的每件事的完整文档 `JSDOM` 分类如下,在一节中 "`JSDOM` 对象 API". ## 自定义jsdom 这个 `JSDOM` 构造器接受第二个参数,可以用以下方式自定义您的jsdom . ### 简单选项 ```js const dom = new JSDOM(``, { url: "https://example.org/", referrer: "https://example.com/", contentType: "text/html", userAgent: "Mellblomenator/9000", includeNodeLocations: true }); ``` - `url` 设置返回的值 `window.location`, (中文(简体) ), `document.URL`,以及 `document.documentURI`,并影响诸如文档中相对URL的解析度,以及获取子资源时使用的同源限制和裁判员。 默认为 `"about:blank"`。 。 。 . - `referrer` 只影响从 `document.referrer`。它默认为无引用者(它反映为空字符串). - `contentType` 影响从 `document.contentType`,以及文档是如何解析的:作为 HTML 或 XML 。 非数值 `"text/html"` 或一个 [XML MIME 类型](https://html.spec.whatwg.org/multipage/infrastructure.html#xml-mime-type) 会投出。 默认为 `"text/html"`。 。 。 . - `userAgent` 影响从 `navigator.userAgent`,以及 `User-Agent` 获取子资源时发送了标题 。 默认为 `` `Mozilla/5.0 (${process.platform}) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/${jsdomVersion}` ``。 。 。 . - `includeNodeLocations` 保存 HTML 解析器生成的位置信息,允许您用 `nodeLocation()` 方法(见下文)。 默认为 `false` 以给出最佳性能,不能使用 XML 内容类型,因为我们的 XML 解析器不支持位置信息. 注意两者 `url` 财务报告和审定财务报表 `referrer` 在他们使用之前就被卡通化了, 所以,例如,如果你通过 `"https:example.com"`,jsdom会解释,就像你给了 `"https://example.com/"`。如果通过一个无法解析的 URL,则该调用会发出。 (按 [URL 标准](http://url.spec.whatwg.org/). ) (中文(简体) ) ### 执行脚本 jsdom最强大的能力是可以在jsdom内部执行脚本. 这些脚本可以修改页面内容并访问所有网络平台APIS jsdom执行. 然而,在处理不可信的内容时,这也非常危险。 jsdom 沙盒不是愚蠢的, 代码运行在 DOM 内部 ` `); // The script will not be executed, by default: dom.window.document.body.children.length === 1; ``` 要启用页面中的执行脚本, 您可以使用 `runScripts: "dangerously"` 选项 : ```js const dom = new JSDOM(` `, { runScripts: "dangerously" }); // The script will be executed and modify the DOM: dom.window.document.body.children.length === 2; ``` 我们再次强调,只有在喂养Jsdom代码时才使用这个代码,你知道是安全的。 如果您在任意用户提供代码上使用,或者在互联网上使用代码,则您正在有效运行不可信Node.js代码,您的机器可能会被损坏. 注意事件处理器属性, 如 `
`,除非 `runScripts` 设置为 `"dangerously"`. (然而,事件处理器 _属性_一样 `div.onclick = ...`,将不管 `runScripts`. ) (中文(简体) ) 如果你只是试图从外部执行脚本,而不是让 ` ``` 如果您不控制页面, 您可以尝试投票等工作方式. 详细情况,请参见下文讨论 [640号](https://github.com/tmpvar/jsdom/issues/640)特别是 [@ matthewkastor (英语)](https://github.com/matthewkastor)是因为 [深刻的评论](https://github.com/tmpvar/jsdom/issues/640#issuecomment-22216965)。 。 。 . ### 共用建筑工和原型机 目前,对于大多数网络平台API,jsdom在多个看起来独立的jsdom之间共享相同的类定义. 这意味着,例如,以下情况可能发生: ```js const dom1 = new JSDOM(); const dom2 = new JSDOM(); dom1.window.Element.prototype.expando = "blah"; console.log(dom2.window.document.createElement("frameset").expando); // logs "blah" ``` 这主要是出于性能和内存的原因:在网络平台上创建所有众多课程的单独拷贝,每次我们创建jsdom,都会相当昂贵. 然而,我们仍有兴趣有一天提供一种选择,以创造出一种“独立”的jsdom,以牺牲某种表演. ### 新API中缺失的特性 相较于从v9.x及之前的旧jsdom API,新API明显缺失了对资源负载的精度控制. 以前版本的jsdom允许您设置在请求时使用的选项(既用于初始请求,也用于旧的等同请求) `JSDOM.fromURL()`,并用于次级资源请求)。 它们也允许您控制哪些子资源被请求并应用到主文档中,以便您可以例如下载样式表而不是脚本. 最后,它们提供了一种自定义的资源加载器,可以让你拦截任何发出的请求,并以完全合成的响应来实现. 这些功能还没有出现在新的jsdom API中,尽管我们希望很快再添加回来! 不幸的是,这要求以合理的方式开展体面的幕后工作. 在此期间,请随意使用旧的jsdom API来获取此功能. 它得到支持和维护,尽管它不会获得新的特征。 文件见 [自由/旧阿皮德](https://npmcn.com/package/%40forbeslindesay/jsdom/lib/old-api.md)。 。 。 . ### 未执行的网络平台部分 虽然我们喜欢在jsdom中添加新的功能并不断更新最新的网页规格,但它有许多缺失的API. 请自由提出一个问题 任何缺失, 但我们是一个小而繁忙的团队, 所以拉请求可能更好. 除了我们还没有达到的特征外, 有两个主要的特征 目前不在jsdom的范围。 它们是: - **导航**: 单击链接或指定时更改全局对象和所有其他对象的能力 `location.href` 或类似. - **版式**: 能够计算由于CSS而将哪些元素直观地布置出来,而CSS会影响各种方法,例如: `getBoundingClientRects()` 或类似属性 `offsetTop`。 。 。 . 目前jsdom对这些功能的某些方面有假行为,例如发送"未执行" `"jsdomError"` ,或返回许多布局相关属性的零。 通常你可以围绕代码中的这些限制工作,例如创建新的 `JSDOM` 在爬行时,或使用 `Object.defineProperty()` 以改变各种布局相关的获取器和方法返回的内容. 注意同一空间中的其他工具,如PhantomJS,确实支持这些特性. 维基百科中的相关条目: 克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克 [jsdom对幽灵JS](https://github.com/tmpvar/jsdom/wiki/jsdom-vs.-PhantomJS)。 。 。 . ## 获得帮助 如果您需要Jsdom的帮助,请随意使用下列任何场所: - 这个 [邮件列表](http://groups.google.com/group/jsdom) (最适合"我如何"的问题) - 这个 [问题跟踪器](https://github.com/tmpvar/jsdom/issues) (最适合错误报告) - IRC 频道 : 自由节日 ## 常见问题 ### @forbeslindesay/jsdom 是什么？ JavaScript 许多网络标准的执行 ### 如何安装 @forbeslindesay/jsdom？ 在项目目录运行 npm install @forbeslindesay/jsdom，或使用 pnpm add / yarn add / bun add。 ### @forbeslindesay/jsdom 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/forbeslindesay\_\_jsdom 是否存在。 ### @forbeslindesay/jsdom 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @forbeslindesay/jsdom 可以商用吗？ @forbeslindesay/jsdom 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @forbeslindesay/jsdom 的下载量有多少？ 根据 npm 官方下载统计，@forbeslindesay/jsdom 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,018 次，日均约 67 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @forbeslindesay/jsdom 还在维护吗？ 最新版本 11\.1\.9 发布于 2017/07/09（9 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/07/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。