kevva

sindresorhus

pageres

samverschueren

import type { BeforeScreenshot } from 'capture-website';

import captureWebsite = require('capture-website');

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

    Number of seconds after which the request is aborted.

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

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

    A string with the same format as a [browser cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) or [an object](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetcookiecookies).

    Tip: Go to the website you want a cookie for and [copy-paste it from DevTools](https://stackoverflow.com/a/24961735/64949).

    readonly cookies?: ReadonlyArray<string | Record<string, string>>;

    Define a customized filename using [Lo-Dash templates](https://lodash.com/docs#template).\

    For example: `<%= date %> - <%= url %>-<%= size %><%= crop %>`.

    - `url`: The URL in [slugified](https://github.com/sindresorhus/filenamify-url) form, eg. `http://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

    @default '<%= url %>-<%= size %><%= crop %>'

    When a file exists, append an incremental number.

    Capture a specific DOM element matching a CSS selector.

    Hide an array of DOM elements matching CSS selectors.

    Username for authenticating with HTTP auth.

    Password for authenticating with HTTP auth.

    readonly format?: 'png' | 'jpg' | 'jpeg';

    readonly beforeScreenShot?: BeforeScreenshot;

    readonly beforeScreenshot?: BeforeScreenshot;

A page to screenshot added in {@link Pageres.src}.

    URL or local path to a website to screenshot. Can also be a data URI.

    Size of screenshot. Uses `<width>x<height>` notation or a keyword.

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

A destination directory set in {@link Pageres.dest}.

export declare type Destination = string;

Buffer data representing a screenshot. Includes the filename from the template in {@link Options.filename}.

export declare type Screenshot = Buffer & {

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.

export default class Pageres extends EventEmitter {

    @returns List of pages that have been already been added.

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

    @param sizes - Use a `<width>x<height>` notation or a keyword.

    A keyword is a version of a device from [this list](https://github.com/kevva/viewport-list/blob/master/data.json).

    You can also pass in the `w3counter` keyword to use the ten most popular resolutions from [w3counter](http://www.w3counter.com/globalstats.php).

    @param options - Options set here will take precedence over the ones set in the constructor.

    const pageres = new Pageres({delay: 2})

        .src('https://github.com/sindresorhus/pageres', ['480x320', '1024x768', 'iphone 5s'], {crop: true})

        .src('https://sindresorhus.com', ['1280x1024', '1920x1080'])

        .src('data:text/html,<h1>Awesome!</h1>', ['1024x768'], {delay: 1});

    src(url: string, sizes: readonly string[], options?: Options): this;

        .src('https://github.com/sindresorhus/pageres', ['480x320'])

    @returns List of screenshot buffer data.

            .src('https://sindresorhus.com', ['1280x1024'])

Object.defineProperty(exports, "__esModule", { value: true });

const url_1 = require("url"); // eslint-disable-line node/no-deprecated-api

const filenamify = require("filenamify");

const unused_filename_1 = require("unused-filename");

const arrayDiffer = require("array-differ");

const getResolutions = require("get-res");

const logSymbols = require("log-symbols");

const captureWebsite = require("capture-website");

const viewportList = require("viewport-list");

const template = require("lodash.template");

const filenamifyUrl = require("filenamify-url");

const writeFile = (0, util_1.promisify)(fs.writeFile);

const getResolutionsMemoized = pMemoize(getResolutions);

const viewportListMemoized = pMemoize(viewportList);

// TODO: Use private class fields when targeting Node.js 12.

class Pageres extends events_1.EventEmitter {

        // Prevent false-positive `MaxListenersExceededWarning` warnings

        this.setMaxListeners(Number.POSITIVE_INFINITY);

        this.options = Object.assign({}, options);

        this.options.filename = (_a = this.options.filename) !== null && _a !== void 0 ? _a : '<%= url %>-<%= size %><%= crop %>';

        this.options.format = (_b = this.options.format) !== null && _b !== void 0 ? _b : 'png';

        this.options.incrementalName = (_c = this.options.incrementalName) !== null && _c !== void 0 ? _c : false;

        this.options.launchOptions = (_d = this.options.launchOptions) !== null && _d !== void 0 ? _d : {};

        this.stats = {}; // eslint-disable-line @typescript-eslint/consistent-type-assertions

        if (!(typeof url === 'string' && url.length > 0)) {

            throw new TypeError('URL required');

        if (!(Array.isArray(sizes) && sizes.length > 0)) {

            throw new TypeError('Sizes required');

        this._source.push({ url, sizes, options });

        if (!(typeof directory === 'string' && directory.length > 0)) {

            throw new TypeError('Directory required');

        await Promise.all(this.src().map(async (source) => {

            const options = Object.assign(Object.assign({}, this.options), source.options);

            const sizes = arrayUniq(source.sizes.filter(size => /^\d{2,4}x\d{2,4}$/i.test(size)));

            const keywords = arrayDiffer(source.sizes, sizes);

            if (sizes.length === 0 && keywords.includes('w3counter')) {

                return this.resolution(source.url, options);

            launchOptions: options.launchOptions,

            beforeScreenShot: options.beforeScreenShot

            beforeScreenshot: options.beforeScreenshot

        if (options.username && options.password) {

            finalOptions.authentication = {

                username: options.username,

                password: options.password

        const screenshot = await captureWebsite.buffer(url, finalOptions);

	"description": "Capture website screenshots",

	"funding": "https://github.com/sponsors/sindresorhus",

			"@typescript-eslint/no-unused-vars": "off"

		@@ -149,3 +149,3 @@ /// <reference types="node" />
		*/
		readonly beforeScreenShot?: BeforeScreenshot;
		readonly beforeScreenshot?: BeforeScreenshot;
		}
		@@ -152,0 +152,0 @@ /**

		{
		"name": "pageres",
		"version": "6.3.0",
		"version": "6.3.1",
		"description": "Capture website screenshots",
		@@ -59,3 +59,3 @@ "license": "MIT",
		"array-uniq": "^2.1.0",
		"capture-website": "^1.2.6",
		"capture-website": "^1.4.0",
		"date-fns": "^2.16.1",
		@@ -96,4 +96,4 @@ "filenamify": "^4.2.0",
		"sinon": "^9.2.2",
		"ts-node": "^9.1.1",
		"typescript": "^4.1.3",
		"ts-node": "^10.7.0",
		"typescript": "^4.6.2",
		"xo": "^0.38.2"
		@@ -100,0 +100,0 @@ },

Improved metrics

Dependency changes

		@@ -212,3 +212,3 @@ "use strict";
		launchOptions: options.launchOptions,
		beforeScreenShot: options.beforeScreenShot
		beforeScreenshot: options.beforeScreenshot
		};
		@@ -215,0 +215,0 @@ if (options.username && options.password) {