Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucacasonato/deno-puppeteer
A port of puppeteer running on Deno
https://github.com/lucacasonato/deno-puppeteer
automation deno headless-chrome puppeteer testing web
Last synced: 2 months ago
JSON representation
A port of puppeteer running on Deno
- Host: GitHub
- URL: https://github.com/lucacasonato/deno-puppeteer
- Owner: lucacasonato
- License: mit
- Created: 2020-12-29T16:28:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T06:57:02.000Z (about 1 year ago)
- Last Synced: 2024-09-30T15:23:41.357Z (2 months ago)
- Topics: automation, deno, headless-chrome, puppeteer, testing, web
- Language: TypeScript
- Homepage: https://deno.land/x/puppeteer
- Size: 651 KB
- Stars: 451
- Watchers: 4
- Forks: 40
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - deno-puppeteer
- awesome-deno - deno-puppeteer - A library which provides a high-level API to control Chromium or Chrome over the DevTools Protocol. (Modules / Testing)
- awesome-deno - deno-puppeteer - 控制Chrome的高层API，适用于浏览器测试。 (模块精选 / 测试)
README
# deno-puppeteer
###### [API](https://github.com/puppeteer/puppeteer/blob/v16.2.0/docs/api.md)
A fork of [Puppeteer](https://pptr.dev/) running on Deno.
> Puppeteer is a library which provides a high-level API to control Chrome,
> Chromium, or Firefox Nightly over the DevTools Protocol. Puppeteer runs
> headless by default, but can be configured to run full (non-headless) Chrome
> or Chromium.
Most things that you can do manually in the browser can be done using Puppeteer!
Here are a few examples to get you started:
- Generate screenshots and PDFs of pages.
- Crawl a SPA (Single-Page Application) and generate pre-rendered content (i.e.
"SSR" (Server-Side Rendering)).
- Automate form submission, UI testing, keyboard input, etc.
- Create an up-to-date, automated testing environment. Run your tests directly
in the latest version of Chrome using the latest JavaScript and browser
features.
- Capture a timeline trace of your site to help diagnose performance issues.
- Test Chrome Extensions.
## Getting Started
### Installation
To use Puppeteer, import it like so:
```ts
import puppeteer from "https://deno.land/x/[email protected]/mod.ts";
```
Puppeteer can use any recent version of Chromium or Firefox Nightly, but this
version of Puppeteer is only validated against a specific version. To cache
these versions in the Puppeteer cache, run the commands below.
```shell
PUPPETEER_PRODUCT=chrome deno run -A --unstable https://deno.land/x/[email protected]/install.ts
PUPPETEER_PRODUCT=firefox deno run -A --unstable https://deno.land/x/[email protected]/install.ts
```
You can find all of the supported environment variables to customize
installation
[in the Puppeteer docs](https://pptr.dev/#?product=Puppeteer&version=v16.2.0&show=api-environment-variables).
### Usage
Puppeteer will be familiar to people using other browser testing frameworks. You
create an instance of `Browser`, open pages, and then manipulate them with
Puppeteer's API.
**Example** - navigating to https://example.com and saving a screenshot as
_example.png_:
Save file as **example.js**
```js
import puppeteer from "https://deno.land/x/[email protected]/mod.ts";
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto("https://example.com");
await page.screenshot({ path: "example.png" });
await browser.close();
```
Execute script on the command line
```bash
deno run -A --unstable example.js
```
Puppeteer sets an initial page size to 800×600px, which defines the screenshot
size. The page size can be customized with
[`Page.setViewport()`](https://github.com/puppeteer/puppeteer/blob/v16.2.0/docs/api.md#pagesetviewportviewport).
**Example** - create a PDF.
Save file as **hn.js**
```js
import puppeteer from "https://deno.land/x/[email protected]/mod.ts";
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto("https://news.ycombinator.com", {
waitUntil: "networkidle2",
});
await page.pdf({ path: "hn.pdf", format: "A4" });
await browser.close();
```
Execute script on the command line
```bash
deno run -A --unstable hn.js
```
See
[`Page.pdf()`](https://github.com/puppeteer/puppeteer/blob/v16.2.0/docs/api.md#pagepdfoptions)
for more information about creating pdfs.
**Example** - evaluate script in the context of the page
Save file as **get-dimensions.js**
```js
import puppeteer from "https://deno.land/x/[email protected]/mod.ts";
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto("https://example.com");
// Get the "viewport" of the page, as reported by the page.
const dimensions = await page.evaluate(() => {
return {
width: document.documentElement.clientWidth,
height: document.documentElement.clientHeight,
deviceScaleFactor: window.devicePixelRatio,
};
});
console.log("Dimensions:", dimensions);
await browser.close();
```
Execute script on the command line
```bash
deno run -A --unstable get-dimensions.js
```
## FAQ
### How does deno-puppeteer compare to the Node version?
`deno-puppeteer` effectively runs a regular version of Puppeteer, except for
some minor changes to make it compatible with Deno.
The most noticable difference is likely that instead of some methods taking /
returning Node `Buffer`, they take / return `Uint8Array`. One method also
returns a web native `ReadableStream` instead of the Node `Readable`.
Other than this, the documentation on https://pptr.dev generally applies.
### How to run in Docker?
An example Dockerfile can be found in this repository. It will install all
necessary dependencies, and shows how to run the ./examples/docker.js.
It is just meant as a jumping off point - customize it as you wish.