# headless

> Headless is a Node.js wrapper for Xvfb, the virtual framebuffer

Latest version **1.2.0** (published 2016-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install headless
pnpm add headless
yarn add headless
bun add headless
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2016-12-05 |
| First published | 2012-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 93 |
| Author | David Björklund |
| Maintainers | kesla |
| Keywords | xvfb, headless |

## Links

- npm: https://www.npmjs.com/package/headless
- Repository: https://github.com/kesla/node-headless
- Issues: https://github.com/kesla/node-headless/issues
- npm.io page: https://npm.io/package/headless

## Recent versions

- 1.2.0 (latest) — 2016-12-05
- 1.1.0 — 2016-11-24
- 1.0.0 — 2014-09-07
- 0.2.1 — 2014-08-26
- 0.2.0 — 2014-08-12
- 0.1.7 — 2014-04-27
- 0.1.6 — 2013-07-14
- 0.1.5 — 2013-07-11
- 0.1.4 — 2013-07-11
- 0.1.3 — 2013-07-06
- 0.1.2 — 2013-06-22
- 0.1.1 — 2012-09-26
- 0.1.0 — 2012-06-27
- 0.0.1 — 2012-03-06

## README

node-headless[![build status](https://secure.travis-ci.org/kesla/node-headless.png)](http://travis-ci.org/kesla/node-headless)
=========

node-headless makes it easy to start and use Xvfb in node.
headless is inspired by xvfb-run - it searches for a free X display number and starts Xvfb on that.

[![NPM](https://nodei.co/npm/headless.png?downloads&stars)](https://nodei.co/npm/headless/)

[![NPM](https://nodei.co/npm-dl/headless.png)](https://nodei.co/npm/headless/)

API
=======

````javascript
var headless = require('headless');

headless(function(err, childProcess, servernum) {
  // childProcess is a ChildProcess, as returned from child_process.spawn()
  console.log('Xvfb running on server number', servernum);
  console.log('Xvfb pid', childProcess.pid);
  console.log('err should be null', err);
});
````

headless also support an optional number to start searching from.

````javascript
var headless = require('headless');

headless(200, function(err, childProcess, servernum) {
  // servernum will be at least 200
  console.log('Xvfb running on server number', servernum);
  console.log('Xvfb pid', childProcess.pid);
});
````

Options:
- `display`: optional display parameters (`width`, `height` & `depth`). If you want to specify `display`, `width` and `height` are required, but `depth` is optional and defaults to 16.
- `args`: an array of arbitrary additional Xvfb arguments
- `stdio`: set the stdio of the spawned Xvfb process(es). Set this to `'inherit'` to see Xvfb's stdout and stderr for debugging purposes.

````javascript
var headless = require('headless');

var options = {
  display: {width: 1024, height: 980, depth: 32},
  args: ['-extension', 'RANDR'],
  stdio: 'inherit'
};

headless(options, function(err, childProcess, servernum) {
  // childProcess is a ChildProcess, as returned from child_process.spawn()
  console.log('Xvfb running on server number', servernum);
  console.log('Xvfb pid', childProcess.pid);
  console.log('err should be null', err);
});
````

install
=======

With [npm](http://npmjs.org), do:

    npm install headless

If you're having problems with Xvfb-instances not getting killed correctly, and is running on a platform that the posix-module supports, install [child-killer](https://npmjs.org/package/child-killer) (`npm install child-killer`) and headless will automatically use it.

Licence
=======

Copyright (c) 2014 David Björklund

This software is released under the MIT license:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/headless · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._