Want to take your software engineering career to the next level? Join the mailing list for career tips & advice Click here

electron-stream

Streaming wrapper around electron

Subscribe to updates I use electron-stream


Statistics on electron-stream

Number of watchers on Github 89
Number of open issues 2
Average time to close an issue about 19 hours
Main language JavaScript
Average time to merge a PR about 7 hours
Open pull requests 1+
Closed pull requests 6+
Last commit over 2 years ago
Repo Created over 4 years ago
Repo Last Updated over 2 years ago
Size 70 KB
Organization / Authorjuliangruber
Contributors4
Page Updated
Do you use electron-stream? Leave a review!
View open issues (2)
View electron-stream activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Software engineers: It's time to get promoted. Starting NOW! Subscribe to my mailing list and I will equip you with tools, tips and actionable advice to grow in your career.
Evaluating electron-stream for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

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

electron-stream open issues Ask a question     (View All Issues)
  • over 4 years be interactive
electron-stream open pull requests (View All Pulls)
  • Added BrowserWindow configuration options support
electron-stream list of languages used
Other projects in JavaScript