Search

Search something to see results

SpeedKitRule

Use rules in your whitelist and blacklist to describe resource patterns.

interface SpeedKitRule {
    contentType?: ContentType[];
    cookie?: Condition;
    desktop?: true;
    hashparam?: Condition;
    host?: Condition;
    mobile?: true;
    pathname?: Condition;
    ruleSetVersion?: number;
    storage?: Condition;
    tablet?: true;
    tv?: true;
    url?: Condition;
}

Index

Properties

Types.SpeedKitRule.contentTypeTypes.SpeedKitRule.cookieTypes.SpeedKitRule.desktopTypes.SpeedKitRule.hashparamTypes.SpeedKitRule.hostTypes.SpeedKitRule.mobileTypes.SpeedKitRule.pathnameTypes.SpeedKitRule.ruleSetVersionTypes.SpeedKitRule.storageTypes.SpeedKitRule.tabletTypes.SpeedKitRule.tvTypes.SpeedKitRule.url

Properties

contentType?: ContentType[]

An array of content types to use.

["document", "style", "script", "image"]

Only apply this rule to HTML documents, CSS files, JavaScript files and images.

cookie?: Condition

A condition tested against cookies.

Use the cookie rule to test if a cookie with a given name and/or value. The Condition that you pass to this attribute will be matched against all available cookies (in the form of name=value) and this rule is fulfilled, when there exists at least one cookie that matches that Condition.

/^PHPSESSID|JSESSID$/

This rule is fulfilled when there exists a cookie with the name PHPSESSID or JSESSID.

1.17.0 - prior versions only match cookie names

desktop?: true

Only fulfills this rule if sent from desktop.

1.5.0

hashparam?: Condition

A condition to test against the hash parameters, e.g. “campaign”.

/campaign/
host?: Condition

A condition to test against the host, e.g. “www.baqend.com”, “www.baqend.com:8443”.

/\.com$/
mobile?: true

Only fulfills this rule if sent from a mobile device.

1.5.0

pathname?: Condition

A condition to test against the path name, e.g. “/some/path/here”.

//robots\.txt$/
ruleSetVersion?: number

The RuleSet version number. This will affect the parsing of the RuleSet.

storage?: Condition

A condition tested against storage entries.

/^userLoggedIn=true$/

2.18.0

tablet?: true

Only fulfills this rule if sent from a tablet.

1.5.0

tv?: true

Only fulfills this rule if sent from a TV.

1.5.0

url?: Condition

A condition to test against the whole URL, e.g. “www.baqend.com/some/path#and-fragment-part”.

/^www\.baqend\.com//