declarativeNetRequest.testMatchOutcome

Checks if any of the extension's declarativeNetRequest rules would match a hypothetical request. Only available while testing, as this is intended to be used during extension development. See Testing for details on how testing is enabled in each browser.

Syntax

let result = await browser.declarativeNetRequest.testMatchOutcome(
    request,                // object
    options                 // optional object
);

Parameters

• request

  • : The details of the request to test.
    • initiator {{optional_inline}}
      • : A string. The initiator URL (if any) for the hypothetical request.
    • method {{optional_inline}}
      • : A string. The standard (lower case) HTTP method of the hypothetical request. Defaults to "get" for HTTP requests and is ignored for non-HTTP requests.
    • tabId {{optional_inline}}
      • : A number. The ID of the tab the hypothetical request takes place in. Does not need to correspond to a real tab ID. Default is -1, meaning that the request isn't related to a tab.
    • type
      • : {{WebExtAPIRef("declarativeNetRequest.ResourceType")}}. The resource type of the hypothetical request.
    • url
      • : A string. The URL of the hypothetical request.

• options {{optional_inline}}

  • : Details of options for the request.
    • includeOtherExtensions {{optional_inline}}
      • : A boolean. Whether matching rules from other extensions are included in matchedRules. When rules from other extensions match, the resulting matchedRule has an extensionId property. Defaults to false.

Return value

A Promise that fulfills with an object with these properties:

• matchedRules
  • : {{WebExtAPIRef("declarativeNetRequest.MatchedRule")}}. Details of the rules (if any) that match the hypothetical request.

If no rules match, the matchedRules array is empty. If the request fails, the promise is rejected with an error message.

Examples

{{WebExtExamples}}

Browser compatibility

{{Compat}}