cf
capture-firefox
npm i capture-firefox
cf

capture-firefox

Capture screenshots using Firefox

by Julian Gruber

0.0.1 (see all)License:MITTypeScript:DefinitelyTyped
npm i capture-firefox
Readme

capture-firefox

Work in progress: This doesn't work yet, due to some firefox headless bugs.

Capture screenshots using Firefox Nightly's new headless mode. This means it does not require a graphical environment / X server to run!

Also you don't even need to have Firefox installed, this will fetch an up to date binary for you.

Example

Capture a 1024x768 screenshot of github.com:

const capture = require('capture-firefox')
const fs = require('fs')

capture({
  url: 'https://github.com/'
}).then(screenshot => {
  fs.writeFileSync(`${__dirname}/example.png`, screenshot)
  console.log('open example.png')
})

github.com

API

screenshot({ url, width = 1024, height = 768 })

Capture a screenshot of url, returns a Promise which resolves with a buffer.

Options:

  • url Page url
  • width Viewport width
  • height Viewport height

Installation

With npm do:

npm install capture-firefox

CI

This project will work in CI environments like Travis and AppVeyor without any additional configuration. It fetches Chromium itself and doesn't need a X server to run.

License

(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.

Downloads/wk

3

GitHub Stars

10

LAST COMMIT

5yrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
0.0.1
latest
5yrs ago
No alternatives found
No tutorials found
Add a tutorial