Skip to content

Easily start and stop an X Virtual Frame Buffer from your node apps

License

Notifications You must be signed in to change notification settings

cypress-io/xvfb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@cypress/xvfb: easily start and stop an X Virtual Frame Buffer from your node apps.

CircleCI semantic-release

Usage

var Xvfb = require('xvfb');
var xvfb = new Xvfb();
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 500.
  • silent - don't pipe Xvfb stderr to the process's stderr.
  • xvfb_args - Extra arguments to pass to Xvfb.

Thanks to

Forked from node-xvfb

both of which served as inspiration for this package.

About

Easily start and stop an X Virtual Frame Buffer from your node apps

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published