capture-phantomjs
Capture screenshots using phantomjs.
Example
Capture a 1024x768
screenshot of twitter.com:
const capture = const fs =
API
screenshot({ url, width = 1024, height = 768, wait = 0, format = 'png', clip = true, cookies = [], ignoreSSLErrors = false, SSLCertificatesPath, SSLProtocol })
Capture a screenshot of url
, returns a Promise
which resolves with a buffer.
Options:
url
Page urlwidth
Viewport widthheight
Viewport heightwait
Time inms
to wait after the page finished loading all initial resourcesformat
File format (png
,jpg
,gif
)clip
Cut the image to exact dimensions, removing the foldcookies
Array of cookie objects, see belowignoreSSLErrors
ignore SSL errorsSSLCertificatesPath
path for PhantomJS to look for SSL certificatesSSLProtocol
Supported protocols:sslv3
,sslv2
,tlsv1
,any
Cookie format
The cookie format is this:
name : 'valid-cookie-name' // required value : 'valid-cookie-value' // required domain : 'the-domain.com' // required path : '/' httponly : true secure : false expires : + 3600 // expires in 1 hour
Installation
With npm do:
npm install capture-phantomjs
This project requires nodejs@8.0.0
or later.
CI
This project will work in CI environments like Travis and AppVeyor without any additional configuration. It fetches phantomjs itself and doesn't need a X server to run.
Related projects
- capture-screenshot — Capture screenshots in multiple browsers
- capture-chrome — Capture screenshots using Chrome
- capture-electron — Capture screenshots using Electron
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.