https://github.com/airtap/headless-support

Returns whether a given browser supports headless mode.
https://github.com/airtap/headless-support

airtap browser headless nodejs npm-package

Last synced: 6 months ago
JSON representation

Returns whether a given browser supports headless mode.

• Host: GitHub
• URL: https://github.com/airtap/headless-support
• Owner: airtap
• License: mit
• Created: 2020-10-04T16:00:48.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T14:42:31.000Z (over 1 year ago)
• Last Synced: 2025-03-28T10:47:41.011Z (6 months ago)
• Topics: airtap, browser, headless, nodejs, npm-package
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# headless-support

**Returns whether a given browser supports headless mode.**

[![npm status](http://img.shields.io/npm/v/headless-support.svg)](https://www.npmjs.org/package/headless-support)

[![node](https://img.shields.io/node/v/headless-support.svg)](https://www.npmjs.org/package/headless-support)

[![Travis build status](https://img.shields.io/travis/com/airtap/headless-support.svg?label=travis)](http://travis-ci.com/airtap/headless-support)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Usage

```js

const headless = require('headless-support')

console.log(headless('chromium', 59, 'linux')) // true

console.log(headless('edge', 59, 'win32'))     // false

console.log(headless('edge', 60, 'win32'))     // true

consoke.log(headless('ff', 56, 'darwin'))      // true

```

## API

### `headless(name[, version][, platform])`

Arguments:

- `name` (string): browser name, loosely matched with [`browser-names`](https://github.com/airtap/browser-names)

- `version` (number or string): browser version, either a major version number (e.g. `85`) or a full version string (`'85.0.564.68'`). If `version` is falsy then latest is assumed.

- `platform` (string): defaults to `process.platform`

Returns a boolean that indicates support of headless mode. For Chromium-based browsers it means they accept a `--headless` flag on the command line, for Firefox it means the browser accepts a `-headless` flag.

## Install

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

```

npm install headless-support

```

## License

[MIT](LICENSE) © 2020-present Airtap contributors