# @garfish/browser-vm 中文文档

规范地址：https://npmcn.com/package/%40garfish/browser-vm/

版本：1\.19\.12
npm 元数据更新时间：2026-08-04T07:27:38.070Z
中文译文更新时间：2026-11-15T23:22:20.653Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40garfish/browser-vm
原文对照：https://npmcn.com/package/%40garfish/browser-vm/?lang=original
项目主页：https://github.com/bytedance/garfish
源码仓库：https://github.com/bytedance/garfish

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：142 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2021-05-07T07:19:45.149Z
- 最新版本发布：2026-08-04T07:27:37.240Z
- 近 30 天下载量：10089（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：381（近 12 个月 2 个）

## 中文简介

vm-sandbox 模块.

## 安装

```sh
npm install @garfish/browser-vm
```

也可以使用：`pnpm add @garfish/browser-vm`、`yarn add @garfish/browser-vm`、`bun add @garfish/browser-vm`

## README

# `@garfish/browser-vm`

[![NPM version](https://img.shields.io/npm/v/@garfish/browser-vm.svg?style=flat-square)](https://www.npmjs.com/package/@garfish/browser-vm)

## 使用量

```js
import vmSandbox from '@garfish/browser-vm';

let nameMap = { a: 'chen' };

const sandbox = new vmSandbox({
  namespace: 'app',
  el: () => document.body,
  modules: [
    () => ({
      override: { nameMap },
      recover() {
        nameMap = { a: 'chen' };
      },
    }),
  ],
});

sandbox.execScript(`
  window.x = 1;
  console.log(window.nameMap); // { a: 'chen' }
  window.nameMap.a = 'tao';
`);

console.log(sandbox.global.x); // 1
console.log(sandbox.global.nameMap); // { a: 'tao' }

// Clear effect
sandbox.clearEffects();
console.log(nameMap); // { a: 'chen' }

// If clear all effects
sandbox.reset();
```

## 钩子

```js
const sandbox = new vmSandbox({
  namespace: 'app',
  el: () => document.body,
});

sandbox.hooks.usePlugin({
  stared(fakeWindow) {},
  closed() {},
  beforeClearEffect() {},
  afterClearEffect() {},
  beforeInvoke(url, env, options) {},
  afterInvoke(url, env, options) {},
  invokeError(err, url, env, options) {},
  appendNode(parentNode, oldNode, convertedNode, tagName) {},
});
```

## 常见问题

### @garfish/browser-vm 是什么？

vm-sandbox 模块\.

### 如何安装 @garfish/browser-vm？

在项目目录运行 npm install @garfish/browser-vm，或使用 pnpm add / yarn add / bun add。

### @garfish/browser-vm 支持 TypeScript 吗？

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

### @garfish/browser-vm 支持 ESM 还是 CommonJS？

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

### @garfish/browser-vm 可以商用吗？

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

### @garfish/browser-vm 的下载量有多少？

根据 npm 官方下载统计，@garfish/browser-vm 在 2026/10/16 – 2026/11/14 这 30 天内被下载 10,089 次，日均约 336 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @garfish/browser-vm 还在维护吗？

最新版本 1\.19\.12 发布于 2026/08/04（3 个月前）；至今共发布 381 个版本，其中过去 12 个月发布了 2 个；首次发布于 2021/05/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

