webRequest.RequestFilter

{{AddonSidebar}} 

An object describing filters to apply to webRequest events.

Type

Values of this type are objects. They contain the following properties:

• urls
  • : array of string. An array of match patterns. The listener will only be called for requests whose targets match any of the given patterns. Only requests made using HTTP or HTTPS will trigger events, other protocols (such as data: and file:) supported by pattern matching do not trigger events. view-source: requests may be matched based on its inner URL.
• types {{optional_inline}} 
  • : array of ``{{WebExtAPIRef(‘webRequest.ResourceType’)}} . A list of resource types (for example, stylesheets, images, scripts). The listener will only be called for requests for resources which are one of the given types.
• tabId {{optional_inline}} 
  • : integer. The listener will only be called for requests from the {{WebExtAPIRef("tabs.Tab", "tab")}}  identified by this ID.
• windowId {{optional_inline}} 
  • : integer. The listener will only be called for requests from the {{WebExtAPIRef("windows.Window", "window")}}  identified by this ID.
• incognito {{optional_inline}} 
  • : boolean. If provided, requests that do not match the incognito state (true or false) will be filtered out.

Browser compatibility

{{Compat}} 

{{WebExtExamples}} 

[!NOTE] This API is based on Chromium’s chrome.webRequest API. This documentation is derived from web_request.json in the Chromium code.