Describes various criteria for filtering URLs. If all of the criteria specified in the filter's properties match the URL, then the filter matches. Filters are often provided to API methods in an
数组
of UrlFilters. For example,
webNavigation
listeners can be added with a filter which is an object with a single
url
property that is an
数组
of UrlFilters, e.g.
{url:[UrlFilter,UrlFilter,...]}
. If any filter within the Array of UrlFilters matches, then it is considered a match for the Array. Effectively, the criteria specified within a single filter are AND'ed together, while all of the individual filters within an Array are OR'ed.
All criteria are case sensitive.
Values of this type are objects. They contain the following properties:
However, note that these last two patterns will not match the last component of the hostname, because no implicit dot is added at the end of the hostname. So for example,
"org."
will match "https://borg.com" but not "https://example.org". To match these patterns, use
hostSuffix
.
hostContains
可选
string
. Matches if the
hostname
of the URL (without protocol or port – see
schemes
and
ports
) contains the given string.
".foo"
. This matches "www.foobar.com" and "foo.com", because an implicit dot is added at the beginning of the hostname.
"foo."
.
".foo."
.
hostEquals
可选
string
. Matches if the hostname of the URL is equal to a specified string.
"www.example.com"
matches "http://www.example.com/" and "https://www.example.com/", but not "http://example.com/".
hostPrefix
可选
string
. Matches if the hostname of the URL starts with a specified string.
hostSuffix
可选
string
. Matches if the hostname of the URL ends with a specified string.
".example.com"
matches "http://www.example.com/", but not "http://example.com/".
"example.com"
matches "http://www.example.com/", and "http://fakeexample.com/".
pathContains
可选
string
. Matches if the path segment of the URL contains a specified string.
pathEquals
可选
string
. Matches if the path segment of the URL is equal to a specified string.
pathPrefix
可选
string
. Matches if the path segment of the URL starts with a specified string.
pathSuffix
可选
string
. Matches if the path segment of the URL ends with a specified string.
queryContains
可选
string
. Matches if the query segment of the URL contains a specified string.
queryEquals
可选
string
. Matches if the query segment of the URL is equal to a specified string.
queryPrefix
可选
string
. Matches if the query segment of the URL starts with a specified string.
querySuffix
可选
string
. Matches if the query segment of the URL ends with a specified string.
urlContains
可选
string
. Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number.
urlEquals
可选
string
. Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number.
urlMatches
可选
string
. Matches if the URL (without fragment identifier) matches a specified
regular expression
. Port numbers are stripped from the URL if they match the default port number.
urlMatches: "^[^:]*:(?://)?(?:[^/]*\\.)?mozilla\\.org/.*$"
matches "https://mozilla.org/", "https://developer.mozilla.org/", but not "https://developer.fakemozilla.org/".
originAndPathMatches
可选
string
. Matches if the URL without query segment and fragment identifier matches a specified
regular expression
. Port numbers are stripped from the URL if they match the default port number.
urlPrefix
可选
string
. Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number.
"https://developer"
matches "https://developer.mozilla.org/" and "https://developers.facebook.com/".
urlSuffix
可选
string
. Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number. Note that an implicit forward slash "/" is added after the host, so
"com/"
matches "https://example.com", but
"com"
不会。
schemes
可选
array
of
string
. Matches if the scheme of the URL is equal to any of the schemes specified in the array. Because schemes are always converted to lowercase, this should always be given in lowercase or it will never match.
["https"]
will match only HTTPS URLs.
ports
可选
array
of (
integer
或 (
array
of
integer
)). An array which may contain integers and arrays of integers. Integers are interpreted as port numbers, while arrays of integers are interpreted as port ranges. Matches if the port of the URL matches any port number or is contained in any ranges.
[80, 443, [1000, 1200]]
matches all requests on ports 80, 443, and in the range 1000-1200.
BCD tables only load in the browser
注意：
This API is based on Chromium's
chrome.events
API. This documentation is derived from
events.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
最后修改： , 由 MDN 贡献者