0.2.0 • Published 10 years ago

abp-filter-parser v0.2.0

Weekly downloads
15
License
MPL-2.0
Repository
github
Last release
10 years ago

abp-filter-parser

JavaScript Adblock Plus filter parser for lists like EasyList

Build Status

Parses filter rules as per:

Usage

Babel / ES6:

import * as ABPFilterParser from 'abp-filter-parser.js';

Node:

let ABPFilterParser = require('abp-filter-parser');

Primary API:

let ABPFilterParser = require('abp-filter-parser');
var fs = require('fs');

let easyListTxt = fs.readFileSync('./test/data/easylist.txt', 'utf-8');
let parsedFilterData = {};
let urlToCheck = 'http://static.tumblr.com/dhqhfum/WgAn39721/cfh_header_banner_v2.jpg';

// This is the site who's URLs are being checked, not the domain of the URL being checked.
let currentPageDomain = 'slashdot.org';

ABPFilterParser.parse(easyListTxt, parsedFilterData);
// ABPFilterParser.parse(someOtherListOfFilters, parsedFilterData);

if (ABPFilterParser.matches(parsedFilterData, urlToCheck, {
      domain: currentPageDomain,
      elementTypeMaskMap: ABPFilterParser.elementTypes.SCRIPT,
    })) {
  console.log('You should block this URL!');
} else {
  console.log('You should NOT block this URL!');
}

Secondary APIs

You probably won't need these directly, they are used by the parimary API above.

  • parseDomains
  • parseOptions
  • parseHTMLFilter
  • parseFilter
  • matchesFilter
0.2.0

10 years ago

0.1.19

10 years ago

0.1.18

10 years ago

0.1.17

10 years ago

0.1.16

10 years ago

0.1.15

10 years ago

0.1.13

10 years ago

0.1.10

10 years ago

0.1.9

10 years ago

0.1.8

10 years ago

0.1.7

10 years ago

0.1.6

10 years ago

0.1.5

10 years ago

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago