@ghostery/adblocker-electron

中文文档
2.20.3发布于 2026/10/28MPL-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 10.1万

Ghostery adblocker Electron wrapper

原始使用文档
文档目录4 节
  1. Getting Started
  2. Usage
  3. Disabling Blocker in session
  4. Caching Blocker using Serialization

Electron Adblocker

Efficient · Minimal · JavaScript · TypeScript · uBlock Origin- and Easylist-compatible
Node.js · Puppeteer · Electron · WebExtension

Github Actions Build Status Github Actions Assets Status Blazing Fast npm version weekly downloads from npm
code style: prettier Follow Ghostery on Twitter Dependabot License Badge LGTM Badge


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!

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:

import { ElectronBlocker } from '@ghostery/adblocker-electron';

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

Fetching lists from URLs:

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:

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

Disabling Blocker in session

To stop blocking ads in a session:

blocker.disableBlockingInSession(session.defaultSession);

Caching Blocker using Serialization

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.

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:

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`!
});

版本与发布记录

@ghostery/adblocker-electron 共发布 65 个版本,首次发布于 2024/10/17;过去 12 个月发布了 24 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.20.3latest2026/10/2818 天前
2.20.12026/10/101 个月前
2.20.02026/10/101 个月前
2.19.02026/10/101 个月前
2.18.22026/08/053 个月前
2.18.12026/07/014 个月前

关于 @ghostery/adblocker-electron 的常见问题

@ghostery/adblocker-electron 是什么?

Ghostery adblocker Electron wrapper

如何安装 @ghostery/adblocker-electron?

在项目目录运行 npm install @ghostery/adblocker-electron,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:electron(>11)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@ghostery/adblocker-electron 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ghostery/adblocker-electron 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ghostery/adblocker-electron 可以商用吗?

@ghostery/adblocker-electron 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@ghostery/adblocker-electron 的下载量有多少?

根据 npm 官方下载统计,@ghostery/adblocker-electron 在 2026/10/17 – 2026/11/15 这 30 天内被下载 101,117 次,日均约 3,371 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ghostery/adblocker-electron 还在维护吗?

最新版本 2.20.3 发布于 2026/10/28(18 天前);至今共发布 65 个版本,其中过去 12 个月发布了 24 个;首次发布于 2024/10/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。