{"id":19151642,"url":"https://github.com/cypress-io/xvfb","last_synced_at":"2025-05-16T00:06:15.291Z","repository":{"id":39005645,"uuid":"95040838","full_name":"cypress-io/xvfb","owner":"cypress-io","description":"Easily start and stop an X Virtual Frame Buffer from your node apps","archived":false,"fork":false,"pushed_at":"2025-03-03T15:54:13.000Z","size":646,"stargazers_count":48,"open_issues_count":14,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-08T11:09:06.516Z","etag":null,"topics":["cypress","util","xvfb"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cypress-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-21T19:57:18.000Z","updated_at":"2025-04-04T03:58:58.000Z","dependencies_parsed_at":"2022-08-20T23:50:08.320Z","dependency_job_id":"5e5b5285-bdb9-45b0-a7ee-130b7dd11e96","html_url":"https://github.com/cypress-io/xvfb","commit_stats":{"total_commits":222,"total_committers":7,"mean_commits":"31.714285714285715","dds":"0.34684684684684686","last_synced_commit":"0051191e4953a2a922086dcdc5c4aae3aecfe5b1"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cypress-io%2Fxvfb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cypress-io%2Fxvfb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cypress-io%2Fxvfb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cypress-io%2Fxvfb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cypress-io","download_url":"https://codeload.github.com/cypress-io/xvfb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cypress","util","xvfb"],"created_at":"2024-11-09T08:15:18.236Z","updated_at":"2025-05-16T00:06:15.262Z","avatar_url":"https://github.com/cypress-io.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## @cypress/xvfb\n\n\u003e easily start and stop an X Virtual Frame Buffer from your node apps.\n\n[![CircleCI](https://circleci.com/gh/cypress-io/xvfb/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/xvfb/tree/master)\n[![Build Status](https://travis-ci.org/cypress-io/xvfb.svg?branch=master)](https://travis-ci.org/cypress-io/xvfb)\n[![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][renovate-badge]][renovate-app]\n\n### Usage\n\n```javascript\nvar Xvfb = require('xvfb');\nvar options = {}; // optional\nvar xvfb = new Xvfb(options);\nxvfb.start(function(err, xvfbProcess) {\n  // code that uses the virtual frame buffer here\n  xvfb.stop(function(err) {\n    // the Xvfb is stopped\n  });\n});\n```\n\nThe Xvfb constructor takes four options:\n\n* \u003ccode\u003edisplayNum\u003c/code\u003e - the X display to use, defaults to the lowest unused display number \u003e= 99 if \u003ccode\u003ereuse\u003c/code\u003e is false or 99 if \u003ccode\u003ereuse\u003c/code\u003e is true.\n* \u003ccode\u003ereuse\u003c/code\u003e - whether to reuse an existing Xvfb instance if it already exists on the X display referenced by displayNum.\n* \u003ccode\u003etimeout\u003c/code\u003e - number of milliseconds to wait when starting Xvfb before assuming it failed to start, defaults to 2000.\n* \u003ccode\u003esilent\u003c/code\u003e - don't pipe Xvfb stderr to the process's stderr.\n* \u003ccode\u003exvfb_args\u003c/code\u003e - Extra arguments to pass to `Xvfb`.\n* \u003ccode\u003eonStderrData\u003c/code\u003e - Function to receive `stderr` output\n\n### Debugging\n\nRun with `DEBUG=xvfb` environment variable to see debug messages. If you want\nto see log messages from the Xvfb process itself, use `DEBUG=xvfb,xvfb-process`.\n\n### Thanks to\n\nForked from [node-xvfb](https://github.com/Rob--W/node-xvfb)\n\n* [kesla](https://github.com/kesla) for https://github.com/kesla/node-headless\n* [leonid-shevtsov](https://github.com/leonid-shevtsov) for https://github.com/leonid-shevtsov/headless\n* [paulbaumgart](https://github.com/paulbaumgart) for creating the initial version of this package.\n\nboth of which served as inspiration for this package.\n\n[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg\n[renovate-app]: https://renovateapp.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcypress-io%2Fxvfb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcypress-io%2Fxvfb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcypress-io%2Fxvfb/lists"}