# @cypress/xvfb 中文文档

规范地址：https://npmcn.com/package/%40cypress/xvfb/

版本：1\.2\.4
npm 元数据更新时间：2022-06-12T16:50:57.926Z
中文译文更新时间：2026-11-11T07:20:10.127Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cypress/xvfb
原文对照：https://npmcn.com/package/%40cypress/xvfb/?lang=original
项目主页：https://github.com/cypress-io/xvfb#readme
源码仓库：https://github.com/cypress-io/xvfb

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

- 包体积（解压后）：10.8 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2017-06-21T16:55:10.296Z
- 最新版本发布：2018-09-28T19:20:23.864Z
- 近 30 天下载量：23446620（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

从您的节点应用中轻松启动并停止 X 虚拟框架缓冲 .

## 安装

```sh
npm install @cypress/xvfb
```

也可以使用：`pnpm add @cypress/xvfb`、`yarn add @cypress/xvfb`、`bun add @cypress/xvfb`

## README

## @ cypress/xvfb (英语)

> 从您的节点应用中轻松启动并停止 X 虚拟框架缓冲 .

[![CircleCI](https://circleci.com/gh/cypress-io/xvfb/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/xvfb/tree/master) [![Build Status](https://travis-ci.org/cypress-io/xvfb.svg?branch=master)](https://travis-ci.org/cypress-io/xvfb) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![renovate-app badge](https://img.shields.io/badge/renovate-app-blue.svg)](https://renovateapp.com/)

### 使用量

```javascript
var Xvfb = require('xvfb');
var options = {}; // optional
var xvfb = new Xvfb(options);
xvfb.start(function(err, xvfbProcess) {
  // code that uses the virtual frame buffer here
  xvfb.stop(function(err) {
    // the Xvfb is stopped
  });
});
```

Xvfb 构造器有四个选项:

-   `displayNum` - 要使用的 X 显示器, 默认为未使用的显示号- 99, 如果 `reuse` 如果 `reuse` 这是真的.
-   `reuse` - 是否重新使用一个已存在的 Xvfb 实例, 如果它已经存在于 showing Num 引用的 X 显示上 .
-   `timeout` - 在启动 Xvfb 时需要等待的毫秒数,然后假设启动失败,默认为2000年.
-   `silent` - 不要把Xvfb Stderr 管道到过程的 stderr.
-   `xvfb_args` - 要传递的额外参数 `Xvfb`。 。 。 .
-   `onStderrData` - 要接收的函数 `stderr` 产出

### 调试

运行 `DEBUG=xvfb` 要看到调试消息的环境变量。 如果你想的话 查看 Xvfb 进程本身的日志消息,使用 `DEBUG=xvfb,xvfb-process`。 。 。 .

### 感谢

从 [节点- xvfb](https://github.com/Rob--W/node-xvfb)

-   [斯拉语name](https://github.com/kesla) 页:1 [https://github.com/kesla/node-headless (英语)](https://github.com/kesla/node-headless)
-   [列奥尼德-谢夫佐夫](https://github.com/leonid-shevtsov) 页:1 [https://github.com/leonid-shevtsov/无头人](https://github.com/leonid-shevtsov/headless)
-   [保罗鲍姆加特](https://github.com/paulbaumgart) 用于创建此软件包的初始版本.

两者都为这个一揽子计划提供了灵感.

## 常见问题

### @cypress/xvfb 是什么？

从您的节点应用中轻松启动并停止 X 虚拟框架缓冲 \.

### 如何安装 @cypress/xvfb？

在项目目录运行 npm install @cypress/xvfb，或使用 pnpm add / yarn add / bun add。

### @cypress/xvfb 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cypress\_\_xvfb 是否存在。

### @cypress/xvfb 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cypress/xvfb 可以商用吗？

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

### @cypress/xvfb 的下载量有多少？

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

### @cypress/xvfb 还在维护吗？

最新版本 1\.2\.4 发布于 2018/09/29（8 年前）；至今共发布 16 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/06/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。