How do I update filter lists in Adblocker?

You need to programmatically fetch new filter lists from sources like Easylist and use the library's parsing methods to update the blocker instance. The README provides examples, but ongoing updates require custom logic or scheduling.

Is Adblocker or uBlock Origin better for building browser extensions?

Adblocker is a library for embedding ad-blocking into custom extensions, offering flexibility and efficiency, while uBlock Origin is a full extension with a UI. Choose Adblocker if you need control over integration, or uBlock Origin for a pre-built solution.

Can I use Adblocker in a mobile app like React Native?

Yes, the standalone JavaScript package works in React Native contexts, allowing ad-blocking within the app's JavaScript environment. However, you'll need to handle the blocking logic and potential performance considerations on mobile devices.

What's the performance overhead when using Adblocker with Puppeteer?

Adblocker is optimized for low overhead, making it suitable for Puppeteer. Performance studies linked in the README indicate it's efficient, but it still adds some processing time for request filtering, which might affect speed in high-volume scenarios.

How can I add custom filter rules to Adblocker?

You can extend the blocker by parsing custom filter lists using the library's methods and combining them with pre-built filters. This requires programmatic handling, as the README shows examples for different environments.

Does Adblocker work with all browsers, including older ones?

Adblocker supports WebExtensions for modern Chrome and Firefox, and standalone JavaScript for other environments. For legacy browsers without WebExtensions or limited JavaScript support, integration may be challenging or impossible.

What are the licensing terms for commercial use of Adblocker?

It's licensed under Mozilla Public License 2.0, which allows commercial use with conditions like disclosing source code for modifications. Always review the license for compliance in your project context.

Open-Awesome

adblocker-electron

MPL-2.0TypeScriptv2.18.2

An efficient, embeddable JavaScript library for blocking ads, trackers, and annoyances across multiple environments.

Visit Website GitHub

1.0k stars122 forks0 contributors

What is adblocker-electron?

Adblocker is an efficient, embeddable JavaScript library for blocking ads, trackers, and annoyances in web applications. It provides seamless integration across environments like Puppeteer, Electron, and WebExtensions, solving the need for performant ad-blocking in custom projects. The library is compatible with popular filter lists like Easylist and uBlock Origin.

Target Audience

Developers building applications that require embedded ad-blocking, such as custom browsers (Electron), headless browsing tools (Puppeteer), browser extensions, or mobile apps using React Native.

Value Proposition

Developers choose Adblocker for its high efficiency, minimal performance overhead, and broad compatibility with existing filter standards. Its modular design allows easy integration into diverse environments without reinventing the wheel.

Overview

Efficient embeddable adblocker library

Use Cases

Best For

Embedding ad-blocking in Electron-based desktop applications
Adding ad and tracker blocking to Puppeteer headless browsers
Building Chrome or Firefox extensions that block ads
Integrating ad-blocking into React Native mobile apps
Processing batch requests for ads/trackers in Node.js
Creating custom browsers with built-in privacy features

Not Ideal For

Projects needing a ready-to-use, GUI-based adblocker for end-users without coding
Server-side applications requiring HTTP-level ad-blocking without JavaScript execution
Environments with strict content security policies that block dynamic filter downloads
Teams seeking drag-and-drop configuration tools with minimal technical setup

Pros & Cons

Pros

Optimized Performance Efficiency

Uses algorithms designed for minimal performance impact, backed by linked studies showing it's among the most efficient adblockers.

Wide Environment Compatibility

Seamlessly integrates with Puppeteer, Electron, WebExtensions, and standalone JavaScript via dedicated packages, as shown in the multi-package structure.

High Filter List Compatibility

Supports 99% of filters from Easylist and uBlock Origin, ensuring comprehensive blocking without reinventing filter standards.

Pre-built Filter Simplicity

Includes methods like `fromPrebuiltAdsAndTracking()` for quick integration, reducing initial setup complexity.

Production-Proven Reliability

Powers adblockers for Ghostery and Cliqz, used by millions in production, demonstrating battle-tested robustness.

Cons

External Filter Dependency

Relies on third-party filter lists like Easylist, which could change or become unavailable, requiring manual updates and maintenance.

JavaScript-Limited Portability

As a JavaScript/TypeScript library, it cannot be easily used in non-JavaScript environments without significant workarounds or porting efforts.

Complex Custom Integration

While basic setup is simple, advanced use cases in non-standard environments may require deep understanding of the library's internals and additional configuration.

Frequently Asked Questions

Related Projects

rxdb

The local-first database that runs on every JS runtime and replicates with your existing backend - no vendor, no lock-in - https://rxdb.info/

Stars23,376

Forks1,175

Last commit18 hours ago

got

🌐 Human-friendly and powerful HTTP request library for Node.js

Stars14,944

Forks998

Last commit6 days ago

electron-builder

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box

Stars14,659

Forks1,873

Last commit17 hours ago

NeDB

The JavaScript Database, for Node.js, nw.js, electron and the browser

Stars13,533

Forks1,011

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub