https://github.com/airtap/electron
Electron browser provider.
https://github.com/airtap/electron
airtap browser electron nodejs npm-package
Last synced: 7 months ago
JSON representation
Electron browser provider.
- Host: GitHub
- URL: https://github.com/airtap/electron
- Owner: airtap
- License: mit
- Created: 2020-08-23T19:29:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T16:58:28.000Z (over 2 years ago)
- Last Synced: 2025-02-17T12:04:44.818Z (8 months ago)
- Topics: airtap, browser, electron, nodejs, npm-package
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# airtap-electron
**Electron [browser provider](https://github.com/airtap/browser-provider).**
[](https://www.npmjs.org/package/airtap-electron)
[](https://www.npmjs.org/package/airtap-electron)
[](http://travis-ci.com/airtap/electron)
[](https://standardjs.com)
## Table of Contents
Click to expand
- [Usage](#usage)
- [Programmatic](#programmatic)
- [With Airtap](#with-airtap)
- [API](#api)
- [`Electron()`](#electron)
- [Browser options](#browser-options)
- [Install](#install)
- [License](#license)
## Usage
### Programmatic
```js
const Electron = require('airtap-electron')
const provider = new Electron()
// Get a list of desired browsers (there's just 1 here)
const wanted = [{ name: 'electron' }]
const manifests = await provider.manifests(wanted)
// Instantiate a browser
const target = { url: 'http://localhost:3000' }
const browser = provider.browser(manifests[0], target)
await browser.open()
```
### With [Airtap](https://github.com/airtap/airtap)
```yaml
providers:
- airtap-electron
browsers:
- name: electron
```
This provider also exposes a [`supports`](https://github.com/airtap/browser-manifest#supports) property to match on:
```yaml
browsers:
- name: electron
supports:
headless: true
```
## API
### `Electron()`
Constructor. Returns an instance of [`browser-provider`](https://github.com/airtap/browser-provider).
### Browser options
- `headless` (boolean, default true): run in headless mode
- `window` (object): custom options to pass to [`BrowserWindow()`](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions)
- `devtools` (object): custom options to pass to [`openDevTools()`](https://www.electronjs.org/docs/api/web-contents#contentsopendevtoolsoptions) (unless `headless`)
In Airtap these can be set like so:
```yaml
browsers:
- name: electron
options:
headless: false
window:
webPreferences:
sandbox: true
devtools:
mode: detach
```
## Install
Electron must be installed separately. With [npm](https://npmjs.org) do:
```
npm install airtap-electron electron
```
## License
[MIT](LICENSE) © 2020-present Airtap contributors