Skip to content
Streaming wrapper around electron
Branch: master
Clone or download
Latest commit a65e5da May 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin rename .nodeIntegration to .node, keep an alias Mar 4, 2017
lib improve onerror handler Jul 10, 2017
.gitignore
.travis.yml travis: update node Oct 9, 2018
Makefile birth yall Oct 28, 2015
README.md add .static option Dec 4, 2017
example.js refactor Oct 29, 2015
index.js add .static option Dec 4, 2017
package-lock.json 7.0.1 May 2, 2019
package.json 7.0.1 May 2, 2019
test.js add .static option Dec 4, 2017

README.md

electron-stream

Write JavaScript to electron, get console output back!

travis downloads

Example

Boot a hidden electron instance, log to stdout and clean up:

var electron = require('electron-stream');

var browser = electron();

browser.pipe(process.stdout);

browser.write('console.log(window.location.href);');
browser.write('window.close();');
browser.end();

Output streams

electron-stream lets you read all of the console output together, or split up into stdout and stderr:

// console.log and console.error
browser.pipe(...);
browser.stdall.pipe(...);

// console.log only
browser.stdout.pipe(...);

// console.error only
browser.stderr.pipe(...);

Installation

To install as a library:

$ npm install electron-stream

To install as a binary:

$ npm install -g electron-stream
$ echo "console.log('foo');window.close()" | electron-stream

Travis

To use electron on travis, add this to your travis.yml:

addons:
  apt:
    packages:
      - xvfb
install:
  - export DISPLAY=':99.0'
  - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
  - npm install

Source.

API

electron([opts])

Create a writable stream around a newly spawned electron which forwards written data to electron. This module bundles electron-prebuilt.

Options:

  • show: Show the electron window. Defaults to false.
  • node: Enable node integration. Defaults to false.
  • basedir: Set this if you need to require node modules in node mode
  • static: Serve static files from this directory at /

electron#stdout

electron#stderr

electron#stdall

Readable streams containing the console output. console.log will be forwarded to .stdout, console.error to .stderr. .stdall has them both.

electron#kill()

Kill the child process.

electron#on('exit', fn)

Emitted when the underlying electron exits. There can be multiple reasons for this:

  • electron#kill() was called
  • window.close() was sent as a script
  • there was a fatal error

License

MIT

You can’t perform that action at this time.