Class Paparazzo

Constructors

constructor

Properties

browser? page?

Methods

getMetaContent getLinks getShot shoot

Constructors

constructor

Properties

Private Optional browser

browser?: Browser

Private Optional page

page?: Page

Methods

Private getMetaContent

  • getMetaContent(page, metaName): Promise<null | string>

  • Parameters

    • page: Page
    • metaName: string

    Returns Promise<null | string>

Private getLinks

  • getLinks(url): Promise<string[]>

  • Parameters

    • url: string

    Returns Promise<string[]>

Private getShot

  • getShot(url, selector, outName, opts): Promise<void>

  • Parameters

    • url: string
    • selector: string
    • outName: string
    • opts: Options

    Returns Promise<void>

shoot

  • shoot(url, selector?, opts?): Promise<void>

  • Take screenshots of page elements.

    Parameters

    • url: string
    • selector: string = 'body'
    • opts: Options = DEFAULT_OPTS

    Returns Promise<void>

    Example

    const paparazzo = new Paparazzo();

    await paparazzo.shoot('https://mysite.com/page/', {
     crawl: true,
     selector: '.sharecard',
     outDir: './sharecards/',
    });

    CLI

    Usage
      $ paparazzo [url] [options]

    Options
      -s, --selector    CSS selector of element on the page to screenshot  (default body)
      -f, --format      Output image format, either "jpeg" or "png"  (default jpeg)
      -o, --outDir      Directory to output image, relative to cwd  (default paparazzo)
      -q, --quality     Image quality (jpeg format only)  (default 90)
      -c, --crawl       Crawl links for other pages  (default false)
      -a, --await       CSS selecor of element to await before taking screenshot
      -t, --timeout     Milliseconds to wait for the page to settle before taking screenshot
      -v, --version     Displays current version
      -h, --help        Displays this message

    Example

    $ paparazzo https://mysite.com/page/ -s ".sharecard" -o "sharecards/" --crawl

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc