Capture screenshots using electron.
- Promise and Stream interfaces
- Configurable Viewport
- Waits for
DOMContentLoaded - File formats
png,jpgandbmp
Capture a 800x600 screenshot of github.com:
const capture = require('capture-electron')
const fs = require('fs')
capture({
url: 'https://github.com/',
width: 800,
height: 600
}).then(screenshot => {
fs.writeFileSync(`${__dirname}/example.png`, screenshot)
console.log('open example.png')
})
Capture a screenshot of url, returns a Promise which resolves with a buffer.
Options:
urlPage urlwidthViewport widthheightViewport heightwaitTime inmsto wait after theDOMContentLoadedeventformatFile format (png,jpg,bmp)
Takes the same options as above, but returns a stream instead.
Example:
capture
.stream({
url: 'https://github.com/',
width: 800,
height: 600
})
.pipe(fs.createWriteStream(`${__dirname}/example-stream.png`))
.on('close', () => console.log('open example-stream.png'))With npm do:
npm install capture-electronThis project requires an xvfb setup to be running in your CI environment.
For an example how to set one up, check out the .travis.yml.
After that, no further setup is required however, as the electron executable is
installed automatically.
- capture-screenshot — Capture screenshots in multiple browsers
- capture-chrome — Capture screenshots using Chrome
- capture-phantomjs — Capture screenshots using PhantomJS
This module is proudly supported by my Sponsors!
Do you want to support modules like this to improve their quality, stability and weigh in on new features? Then please consider donating to my Patreon. Not sure how much of my modules you're using? Try feross/thanks!
(MIT)
Copyright (c) 2017 Julian Gruber <julian@juliangruber.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.