platform/blocker/blocker-types

Interfaces

ContentBlockerOptions

Defined in: app/src/platform/blocker/blocker-types.ts:42

Options of the content blocker.

Properties

dataDir

readonly dataDir: string

Defined in: app/src/platform/blocker/blocker-types.ts:44

Folder with engine.bin, built by tools/blocker/build.ts.

enabled

readonly enabled: (pageUrl) => boolean

Defined in: app/src/platform/blocker/blocker-types.ts:46

Whether blocking is on for a page, by its address; read for every request.

Parameters

pageUrl

string

Returns

boolean

extras?

readonly optional extras?: () => readonly ExtraLists[]

Defined in: app/src/platform/blocker/blocker-types.ts:52

The groups of optional lists that are on; read for every request and frame.

Returns

readonly ExtraLists[]

logger

readonly logger: Logger

Defined in: app/src/platform/blocker/blocker-types.ts:53

onBlocked?

readonly optional onBlocked?: (webContentsId) => void

Defined in: app/src/platform/blocker/blocker-types.ts:48

Called for every blocked request, with the id of the tab’s web contents.

Parameters

webContentsId

number

Returns

void

onStatus?

readonly optional onStatus?: (status) => void

Defined in: app/src/platform/blocker/blocker-types.ts:50

Called when the status of the content blocker changes.

Parameters

status

BlockerStatus

Returns

void

---

ExtendedRule

Defined in: app/src/platform/blocker/blocker-types.ts:7

A procedural rule, such as :has-text(): the frame finds its elements itself, then marks them with the attribute that the style sheet hides, or runs the directive on them.

Properties

ast

readonly ast: unknown

Defined in: app/src/platform/blocker/blocker-types.ts:9

The selector of the elements, parsed.

attribute?

readonly optional attribute?: string

Defined in: app/src/platform/blocker/blocker-types.ts:11

The attribute that hides an element, for hiding rules.

directive?

readonly optional directive?: unknown

Defined in: app/src/platform/blocker/blocker-types.ts:13

What to do with an element, such as removing it, for the other rules.

---

FrameElements

Defined in: app/src/platform/blocker/blocker-types.ts:29

The classes, ids and link targets that a frame reported.

Properties

classes

readonly classes: readonly string[]

Defined in: app/src/platform/blocker/blocker-types.ts:30

hrefs

readonly hrefs: readonly string[]

Defined in: app/src/platform/blocker/blocker-types.ts:32

ids

readonly ids: readonly string[]

Defined in: app/src/platform/blocker/blocker-types.ts:31

---

FrameRules

Defined in: app/src/platform/blocker/blocker-types.ts:17

The rules for a frame that starts.

Properties

elements

readonly elements: boolean

Defined in: app/src/platform/blocker/blocker-types.ts:25

Whether the frame should report its elements for the generic hiding rules.

extended

readonly extended: readonly ExtendedRule[]

Defined in: app/src/platform/blocker/blocker-types.ts:23

Procedural rules of the frame’s address.

scripts

readonly scripts: readonly string[]

Defined in: app/src/platform/blocker/blocker-types.ts:21

Scriptlets that run in the page’s world before its own scripts.

styles

readonly styles: string

Defined in: app/src/platform/blocker/blocker-types.ts:19

Element hiding rules of the frame’s address, as a style sheet.

Type Aliases

BlockerStatus

BlockerStatus = "idle" | "loading" | "ready" | "failed"

Defined in: app/src/platform/blocker/blocker-types.ts:36

Where the content blocker is: not loaded yet, loading, working, or without usable data.

---

ExtraLists

ExtraLists = "cookies" | "annoyances"

Defined in: app/src/platform/blocker/blocker-types.ts:39

A group of optional lists with an engine of its own: cookie notices or annoyances.