Electron Adblocker

Efficient
· Minimal
· JavaScript
· TypeScript
· uBlock Origin- and Easylist-compatible




Node.js
· Puppeteer
· Electron
· WebExtension

---

Getting Started

Install: npm install --save @ghostery/adblocker-electron.

Usage

For a complete example check-out: @ghostery/adblocker-electron-example.

Creating an instance of ElectronBlocker and start blocking ads!

``javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';
import fetch from 'cross-fetch'; // required 'fetch'

ElectronBlocker.fromPrebuiltAdsAndTracking(fetch).then((blocker) => {
blocker.enableBlockingInSession(session.defaultSession);
});
`

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:
`javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';

const blocker = ElectronBlocker.parse(fs.readFileSync('easylist.txt', 'utf-8'));
`

Fetching lists from URLs:
`javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';
import fetch from 'cross-fetch'; // required 'fetch'

const blocker = await ElectronBlocker.fromLists(fetch, [
'https://easylist.to/easylist/easylist.txt'
]);
`

Use ready-made configs to block ads and optionally trackers:
`javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';
import fetch from 'cross-fetch'; // required 'fetch'

let blocker = await ElectronBlocker.fromPrebuiltAdsOnly(fetch); // ads only
blocker = await ElectronBlocker.fromPrebuiltAdsAndTracking(fetch); // ads and tracking
`

$3

To stop blocking ads in a session:

`javascript
blocker.disableBlockingInSession(session.defaultSession);
`

$3

To avoid having to create the same instance of ElectronBlocker all over again,
you can serialize it to a byte-array which you can store on disk for faster
loading.

`javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';
import fetch from 'cross-fetch'; // required 'fetch'
import { promises as fs } from 'fs'; // used for caching

ElectronBlocker.fromPrebuiltAdsAndTracking(fetch, {
path: 'engine.bin',
read: fs.readFile,
write: fs.writeFile,
}).then((blocker) => {
blocker.enableBlockingInSession(session.defaultSession);
});
`

Or you can do this manually to control the way caching is done:

`javascript
import { ElectronBlocker } from '@ghostery/adblocker-electron';
import fetch from 'cross-fetch'; // required 'fetch'

ElectronBlocker.fromPrebuiltAdsAndTracking(fetch).then((blocker) => {
const buffer = blocker.serialize();
const restoredBlocker = ElectronBlocker.deserialize(buffer);
// restoredBlocker is deep-equal to blocker!
});
``