@cliqz/adblocker-playwright
Advanced tools
Efficient
· Minimal
· JavaScript
· TypeScript
· uBlock Origin- and Easylist-compatible
Node.js
· Puppeteer
· Electron
· WebExtension
Install: npm install --save @cliqz/adblocker-playwright.
For a complete example check-out: @cliqz/adblocker-playwright-example.
Creating an instance of PlaywrightBlocker and start blocking ads!
import * as pw from 'playwright';
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
import fetch from 'cross-fetch'; // required 'fetch'
const browser = await pw.firefox.launch({ headless: false });
const page = await browser.newPage();
PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch).then((blocker) => {
blocker.enableBlockingInPage(page);
});
You are ready to block ads!
There are other ways you can create an instance of the blocking engine to start blocking ads.
If you already have filters locally:
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
const blocker = PlaywrightBlocker.parse(fs.readFileSync('easylist.txt', 'utf-8'));
Fetching lists from URLs:
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
import fetch from 'cross-fetch'; // required 'fetch'
const blocker = await PlaywrightBlocker.fromLists(fetch, [
'https://easylist.to/easylist/easylist.txt'
]);
Use ready-made configs to block ads and optionally trackers:
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
import fetch from 'cross-fetch'; // required 'fetch'
let blocker = await PlaywrightBlocker.fromPrebuiltAdsOnly(fetch); // ads only
blocker = await PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch); // ads and tracking
To stop blocking ads in a page:
await blocker.disableBlockingInPage(page);
To avoid having to create the same instance of PlaywrightBlocker all over again,
you can serialize it to a byte-array which you can store on disk for faster
loading.
import * as pw from 'playwright';
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
import fetch from 'cross-fetch'; // required 'fetch'
import { promises as fs } from 'fs'; // used for caching
const browser = await pw.firefox.launch({ headless: false });
const page = await browser.newPage();
PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch, {
path: 'engine.bin',
read: fs.readFile,
write: fs.writeFile,
}).then((blocker) => {
blocker.enableBlockingInPage(page);
});
Or you can do this manually to control the way caching is done:
import { PlaywrightBlocker } from '@cliqz/adblocker-playwright';
import fetch from 'cross-fetch'; // required 'fetch'
PlaywrightBlocker.fromPrebuiltAdsAndTracking(fetch).then((blocker) => {
const buffer = blocker.serialize();
const restoredBlocker = PlaywrightBlocker.deserialize(buffer);
// `restoredBlocker` is deep-equal to `blocker`!
});
v1.28.0 (Tue Jul 09 2024)
@ghostery/adblocker-content, @ghostery/adblocker-webextension-cosmetics
DOMMonitor #4071 (@seia-soto @chrmod @philipp-classen)@ghostery/adblocker-content, @ghostery/adblocker-electron-preload, @ghostery/adblocker-electron, @ghostery/adblocker-extended-selectors, @ghostery/adblocker-playwright, @ghostery/adblocker-puppeteer, @ghostery/adblocker-webextension-cosmetics, @ghostery/adblocker-webextension, @ghostery/adblocker
@ghostery/adblocker-puppeteer
@ghostery/adblocker-electron-preload, @ghostery/adblocker-electron
FAQs
Ghostery adblocker Playwright wrapper
The npm package @cliqz/adblocker-playwright receives a total of 2,068 weekly downloads. As such, @cliqz/adblocker-playwright popularity was classified as popular.
We found that @cliqz/adblocker-playwright demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.