https://github.com/DarkGL/node-xvfb-ts

Easily start and stop an X Virtual Frame Buffer from your node apps
https://github.com/DarkGL/node-xvfb-ts

buffer frame framebuffer headless playwright puppeteer typescript virtual xvfb xvfb-node xvfb-ts

Last synced: about 13 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/DarkGL/node-xvfb-ts
• Owner: DarkGL
• License: mit
• Created: 2024-05-14T21:21:57.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-28T17:48:12.000Z (2 months ago)
• Last Synced: 2025-01-31T07:11:09.829Z (4 days ago)
• Topics: buffer, frame, framebuffer, headless, playwright, puppeteer, typescript, virtual, xvfb, xvfb-node, xvfb-ts
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/xvfb-ts
• Size: 143 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-xvfb-ts

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

-----

## Usage

```typescript

import { Xvfb } from 'xvfb-ts';

const xvfb = new Xvfb();

await xvfb.start();

// code that uses the virtual frame buffer here

await xvfb.stop();

// 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

* [Rob--W](https://github.com/Rob--W) for [xvfb](https://github.com/Rob--W/node-xvfb)