View pageres on Snyk Open Source Advisor

Package Health Score

68 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
8.0.0	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.1.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.3.1	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.2.1	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.0	\|	03/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (898)

GitHub Stars: 9.63K
Forks: 746
Contributors: 40

Direct Usage Popularity

The npm package pageres receives a total of 898 downloads a week. As such, we scored pageres popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package pageres, we found that it has been starred 9,632 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 40
Funding: Yes

With more than 10 contributors for the pageres repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 20
Open PR: 0
Last Release: 6 months ago
Last Commit: 6 months ago

Further analysis of the maintenance status of pageres based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that pageres demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18

Age: 10 years
Dependencies: 16 Direct
Versions: 53
Install Size: 26.4 kB
Dist-tags: 1
# of Files: 5
Maintainers: 2
TS Typings: Yes

pageres has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use pageres?

To help you get started, we've collected the most common ways that pageres is being used within popular public projects.

visjs / vis-network / scripts / examples-index / generate.ts View on Github

// it runs after the existing scripts on the page and therefore doesn't
    // allow to modify things prior to their invocation.
    const tmpPath = path.join(
      path.dirname(example.path),
      ".tmp.example.screenshot." + path.basename(example.path)
    );
    const screenshotPage = cheerio.load(example.html);
    screenshotPage("head").prepend(
      cheerio("

View more ways to use pageres

Capture screenshots of websites in various resolutions. A good way to make sure your websites are responsive. It's speedy and generates 100 screenshots from 10 different websites in just over a minute. It can also be used to render SVG images.

See pageres-cli for the command-line tool.

Install

npm install pageres

Note to Linux users: If you get a "No usable sandbox!" error, you need to enable system sandboxing.

Usage

import Pageres from 'pageres';

await new Pageres({delay: 2})
	.source('https://github.com/sindresorhus/pageres', ['480x320', '1024x768'], {crop: true})
	.source('https://sindresorhus.com', ['1280x1024', '1920x1080'])
	.source('data:text/html,<h1>Awesome!</h1>', ['1024x768'])
	.destination('screenshots')
	.run();

console.log('Finished generating screenshots!');

API

Pageres(options?)

options

Type: object

delay

Type: number (Seconds)
Default: 0

Delay capturing the screenshot.

Useful when the site does things after load that you want to capture.

timeout

Type: number (Seconds)
Default: 60

Number of seconds after which the request is aborted.

crop

Type: boolean
Default: false

Crop to the set height.

css

Type: string

Apply custom CSS to the webpage. Specify some CSS or the path to a CSS file.

script

Type: string

Apply custom JavaScript to the webpage. Specify some JavaScript or the path to a file.

cookies

Type: Array

A string with the same format as a browser cookie or an object.

Tip: Go to the website you want a cookie for and copy-paste it from DevTools.

filename

Type: string
Default: '<%= url %>-<%= size %><%= crop %>'

Define a customized filename using Lo-Dash templates.
For example: <%= date %> - <%= url %>-<%= size %><%= crop %>.

Available variables:

url: The URL in slugified form, eg. https://yeoman.io/blog/ becomes yeoman.io!blog
size: Specified size, eg. 1024x1000
width: Width of the specified size, eg. 1024
height: Height of the specified size, eg. 1000
crop: Outputs -cropped when the crop option is true
date: The current date (YYYY-MM-DD), eg. 2015-05-18
time: The current time (HH-mm-ss), eg. 21-15-11

incrementalName

Type: boolean
Default: false

When a file exists, append an incremental number.

selector

Type: string

Capture a specific DOM element matching a CSS selector.

hide

Type: string[]

Hide an array of DOM elements matching CSS selectors.

username

Type: string

Username for authenticating with HTTP auth.

password

Type: string

Password for authenticating with HTTP auth.

scale

Type: number
Default: 1

Scale webpage n times.

format

Type: string
Default: png
Values: 'png' | 'jpg'

Image format.

userAgent

Type: string

Custom user agent.

headers

Type: object

Custom HTTP request headers.

transparent

Type: boolean
Default: false

Set background color to transparent instead of white if no background is set.

darkMode

Type: boolean
Default: false

Emulate preference of dark color scheme.

launchOptions

Type: object
Default: {}

Options passed to puppeteer.launch().

beforeScreenshot

Type: Function

The specified function is called right before the screenshot is captured, as well as before any bounding rectangle is calculated as part of options.element. It receives the Puppeteer Page instance as the first argument and the browser instance as the second argument. This gives you a lot of power to do custom stuff. The function can be async.

Note: Make sure to not call page.close() or browser.close().

import Pageres from 'pageres';

await new Pageres({
	delay: 2,
	beforeScreenshot: async (page, browser) =&gt; {
		await checkSomething();
		await page.click('#activate-button');
		await page.waitForSelector('.finished');
	}
})
	.source('https://github.com/sindresorhus/pageres', ['480x320', '1024x768', 'iphone 5s'], {crop: true})
	.destination('screenshots')
	.run();

console.log('Finished generating screenshots!');

pageres.source(url, sizes, options?)

Add a page to screenshot.

url

Required
Type: string

URL or local path to the website you want to screenshot. You can also use a data URI.

sizes

Required
Type: string[]

Use a x notation or a keyword.

A keyword is a version of a device from this list.

You can also pass in the w3counter keyword to use the ten most popular resolutions from w3counter.

options

Type: object

Options set here will take precedence over the ones set in the constructor.

pageres.destination(directory)

Set the destination directory.

pageres.run()

Run pageres.

Returns Promise.

Task runners

Check out grunt-pageres if you're using Grunt.

For Gulp and Broccoli, just use the API directly. No need for a wrapper plugin.

Built with Pageres

Break Shot - Desktop app for capturing screenshots of responsive websites.

capture-website - A different take on screenshotting websites

pageres dependencies

array-differ array-uniq capture-website date-fns filenamify filenamify-url get-res lodash.template log-symbols make-dir p-map p-memoize plur type-fest unused-filename viewport-list

FAQs

What is pageres?

Capture website screenshots. Visit Snyk Advisor to see a full health score report for pageres, including popularity, security, maintenance & community analysis.

Is pageres popular?

The npm package pageres receives a total of 898 weekly downloads. As such, pageres popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pageres well maintained?

We found indications that pageres maintenance is sustainable demonstrating some project activity. We saw a total of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is pageres safe to use?

While scanning the latest version of pageres, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 26 April-2024, at 07:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (898)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use pageres?

Install

Usage

API

Pageres(options?)

options

delay

timeout

crop

css

script

cookies

filename

incrementalName

selector

hide

username

password

scale

format

userAgent

headers

transparent

darkMode

launchOptions

beforeScreenshot

pageres.source(url, sizes, options?)

url

sizes

options

pageres.destination(directory)

directory

pageres.run()

Task runners

Built with Pageres

Related

pageres dependencies

pageres development dependencies

FAQs

What is pageres?

Is pageres popular?

Is pageres well maintained?

Is pageres safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues