MDN self-hosted library · e01.org

declarativeNetRequest.URLTransform

Details describing a URL transformation to perform for a redirect rule. This object can be specified at rule.action.redirect.transform.

no runnable cells webextension-api-type upstream source

Details describing a URL transformation to perform for a redirect rule. This object can be specified at rule.action.redirect.transform.

Type

Values of this type are objects. They contain these properties:

  • fragment
  • : A string. The new fragment for the request. Should be either empty, in which case the existing fragment is cleared; or should begin with '#'.
  • host
  • : A string. The new host name for the request.
  • password
  • : A string. The new password for the request.
  • path
  • : A string. The new path for the request. If empty, the existing path is cleared.
  • port
  • : A string. The new port for the request. If empty, the existing port is cleared.
  • query
  • : A string. The new query for the request. Should be either empty, in which case the existing query is cleared; or should begin with '?'.
  • queryTransform
  • : An object describing how to add, remove, or replace query key-value pairs. Cannot be specified if 'query' is specified.

    • addOrReplaceParams
    • : An array of objects describing the list of query key-value pairs (key=value) to be added or replaced.

      • key
      • : A string. The key part of key=value.
      • replaceOnly
      • : A boolean. If true, the query key is replaced only if it's already present. Otherwise, the key is also added if it's missing. Defaults to false.
      • value
      • : A string. The value part of key=value.
    • removeParams

    • : An array of string. The list of query keys to be removed.
  • scheme

  • : A string. The new scheme for the request. Allowed values are "http", "https", and the scheme of the extension, for example, "moz-extension" in Firefox or "chrome-extension" in Chrome. When the extension scheme is used, the host must be specified to generate a meaningful redirection target.
  • username
  • : A string. The new username for the request.

Browser compatibility