https://github.com/cypress-io/xvfb
Easily start and stop an X Virtual Frame Buffer from your node apps
https://github.com/cypress-io/xvfb
cypress util xvfb
Last synced: 5 months ago
JSON representation
Easily start and stop an X Virtual Frame Buffer from your node apps
- Host: GitHub
- URL: https://github.com/cypress-io/xvfb
- Owner: cypress-io
- License: other
- Created: 2017-06-21T19:57:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T15:54:13.000Z (7 months ago)
- Last Synced: 2025-04-08T11:09:06.516Z (6 months ago)
- Topics: cypress, util, xvfb
- Language: JavaScript
- Size: 631 KB
- Stars: 48
- Watchers: 5
- Forks: 6
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## @cypress/xvfb
> easily start and stop an X Virtual Frame Buffer from your node apps.
[](https://circleci.com/gh/cypress-io/xvfb/tree/master)
[](https://travis-ci.org/cypress-io/xvfb)
[](https://github.com/semantic-release/semantic-release) [![renovate-app badge][renovate-badge]][renovate-app]
### Usage
```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
});
});
```
The Xvfb constructor takes four options:
* displayNum - the X display to use, defaults to the lowest unused display number >= 99 if reuse is false or 99 if reuse is true.
* reuse - whether to reuse an existing Xvfb instance if it already exists on the X display referenced by displayNum.
* timeout - number of milliseconds to wait when starting Xvfb before assuming it failed to start, defaults to 2000.
* silent - don't pipe Xvfb stderr to the process's stderr.
* xvfb_args - Extra arguments to pass to `Xvfb`.
* onStderrData - Function to receive `stderr` output
### Debugging
Run with `DEBUG=xvfb` environment variable to see debug messages. If you want
to see log messages from the Xvfb process itself, use `DEBUG=xvfb,xvfb-process`.
### Thanks to
Forked from [node-xvfb](https://github.com/Rob--W/node-xvfb)
* [kesla](https://github.com/kesla) for https://github.com/kesla/node-headless
* [leonid-shevtsov](https://github.com/leonid-shevtsov) for https://github.com/leonid-shevtsov/headless
* [paulbaumgart](https://github.com/paulbaumgart) for creating the initial version of this package.
both of which served as inspiration for this package.
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/