@amplitude/rrweb-snapshot

中文文档
2.1.6发布于 2026/11/05MITTypeScriptESM + CJS构建来源已验证近 30 天下载 516万

rrweb's component to take a snapshot of DOM, aka DOM serializer

原始使用文档

rrweb-snapshot

Build Status Join the chat at slack

Snapshot the DOM into a stateful and serializable data structure. Also, provide the ability to rebuild the DOM via snapshot.

API

This module export following methods:

snapshot

snapshot will traverse the DOM and return a stateful and serializable data structure which can represent the current DOM view.

There are several things will be done during snapshot:

  1. Inline some DOM states into HTML attributes, e.g, HTMLInputElement's value.
  2. Turn script tags into noscript tags to avoid scripts being executed.
  3. Try to inline stylesheets to make sure local stylesheets can be used.
  4. Make relative paths in href, src, CSS to be absolute paths.
  5. Give an id to each Node, and return the id node map when snapshot finished.

rebuild

rebuild will build the DOM according to the taken snapshot.

There are several things will be done during rebuild:

  1. Add data-rrid attribute if the Node is an Element.
  2. Create some extra DOM node like text node to place inline CSS and some states.
  3. Add data-extra-child-index attribute if Node has some extra child DOM.

serializeNodeWithId

serializeNodeWithId can serialize a node into snapshot format with id.

buildNodeWithSN

buildNodeWithSN will build DOM from serialized node and store serialized information in the mirror.getMeta(node).

版本与发布记录

@amplitude/rrweb-snapshot 共发布 33 个版本,首次发布于 2023/10/24;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.1.6latest2026/11/051 天前
2.1.52026/10/2314 天前
2.1.22026/07/014 个月前
2.1.02026/05/125 个月前
2.0.0-alpha.402026/05/046 个月前
2.0.0-alpha.392026/04/017 个月前

其他发布通道:alpha → 2.0.0-alpha.12。

关于 @amplitude/rrweb-snapshot 的常见问题

@amplitude/rrweb-snapshot 是什么?

rrweb's component to take a snapshot of DOM, aka DOM serializer

如何安装 @amplitude/rrweb-snapshot?

在项目目录运行 npm install @amplitude/rrweb-snapshot,或使用 pnpm add / yarn add / bun add。

@amplitude/rrweb-snapshot 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@amplitude/rrweb-snapshot 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@amplitude/rrweb-snapshot 可以商用吗?

@amplitude/rrweb-snapshot 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@amplitude/rrweb-snapshot 的下载量有多少?

根据 npm 官方下载统计,@amplitude/rrweb-snapshot 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,159,625 次,日均约 171,988 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@amplitude/rrweb-snapshot 还在维护吗?

最新版本 2.1.6 发布于 2026/11/05(1 天前);至今共发布 33 个版本,其中过去 12 个月发布了 11 个;首次发布于 2023/10/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。