Interface URLPurifyConfig

interface URLPurifyConfig {
    hashFromMemory?: string;
    hashUrl?: string;
    instancePickMode?: InstancePickMode;
    onFetchedRedirectServices?: (newServices: SerializedServices) => void;
    onFetchedRules?: (newHash: string, newRules: SerializedRules) => void;
    redirectServicesFromMemory?: SerializedServices;
    redirectServicesUrl?: string;
    referralMarketing?: boolean;
    rulesFromMemory?: SerializedRules;
    ruleUrl?: string;
}

Properties

hashFromMemory? hashUrl? instancePickMode? onFetchedRedirectServices? onFetchedRules? redirectServicesFromMemory? redirectServicesUrl? referralMarketing? rulesFromMemory? ruleUrl?

Properties

OptionalhashFromMemory

hashFromMemory?: string

sha256 hash of a previously fetched ruleset

OptionalhashUrl

hashUrl?: string

URL for sha256 hash of the up-to-date ruleset

OptionalinstancePickMode

instancePickMode?: InstancePickMode

Whether to select the first available instance or pick a random one

OptionalonFetchedRedirectServices

onFetchedRedirectServices?: (newServices: SerializedServices) => void

Callback function to be called when new redirect services URLs are fetched

OptionalonFetchedRules

onFetchedRules?: (newHash: string, newRules: SerializedRules) => void

Callback function to be called when new rules are fetched

OptionalredirectServicesFromMemory

redirectServicesFromMemory?: SerializedServices

Previously fetched redirect services URLs

OptionalredirectServicesUrl

redirectServicesUrl?: string

URL for up-to-date redirect services URLs

OptionalreferralMarketing

referralMarketing?: boolean

Remove referral marketing parameters from URLs

OptionalrulesFromMemory

rulesFromMemory?: SerializedRules

Previously fetched URL cleaning rules

OptionalruleUrl

ruleUrl?: string

URL for up-to-date URL cleaning rules

Settings

Member Visibility

On This Page

Properties