Class URLPurify

Index

Constructors

Methods

clearUrl setRedirectServices setRules setUrls

Constructors

constructor

new URLPurify(__namedParameters: URLPurifyConfig): URLPurify
Parameters
- __namedParameters: URLPurifyConfig
Returns URLPurify
- Defined in main.ts:44

Methods

clearUrl

clearUrl(url: string, removeFields?: boolean, redirect?: boolean): string
Clears tracking elements from a URL.
Parameters
- url: string
  The URL to clear tracking elements from.
- removeFields: boolean = true
  Whether to remove tracking fields from the URL.
- redirect: boolean = true
  Whether to redirect to one of available proxy services.
Returns string
URL without tracking elements.
- Defined in main.ts:130

setRedirectServices

setRedirectServices(redirectServices: SerializedServices): void
Sets redirect services provided by the user.
Parameters
- redirectServices: SerializedServices
  The list of redirect services.
Returns void
- Defined in main.ts:190

setRules

setRules(rules: SerializedRules, _hash?: string): void
Sets rules provided by the user.
Parameters
- rules: SerializedRules
  The rules object.
- Optional_hash: string
  The sha256 hash of the rules object (currently unused).
Returns void
- Defined in main.ts:173

setUrls

setUrls(ruleUrl: string, _hashUrl?: string): void
Sets the URLs for rules database and hash source.
Parameters
- ruleUrl: string
  The URL for the rules database.
- Optional_hashUrl: string
  The URL for the hash source (currently unused).
Returns void
- Defined in main.ts:182