TheURLPattern interface of theURL Pattern API matches URLs or parts of URLs against a pattern. The pattern can contain capturing groups that extract parts of the matched URL.

More information about the syntax of patterns can be found on the API overviewpage:URL Pattern API.

Constructor

URLPattern()

Returns a newURLPattern object based on the given pattern and base URL.

Instance properties

hashRead only

A string containing a pattern to match thehash partof a URL.

hasRegExpGroupsRead only

A boolean indicating whether or not any of theURLPattern components containregular expression capturing groups.

hostnameRead only

A string containing a pattern to match thehostnamepart of a URL.

passwordRead only

A string containing a pattern to match thepasswordpart of a URL.

pathnameRead only

A string containing a pattern to match thepathnamepart of a URL.

portRead only

A string containing a pattern to match theport partof a URL.

protocolRead only

A string containing a pattern to match theprotocolpart of a URL.

searchRead only

A string containing a pattern to match thesearch partof a URL.

usernameRead only

A string containing a pattern to match theusernamepart of a URL.

Instance methods

exec()

Returns an object with the matched parts of the URL ornull if the URLdoes not match.

test()

Returnstrue if the URL matches the given pattern,false otherwise.

Specifications

Browser compatibility

See also

• A polyfill ofURLPattern is availableon GitHub
• The pattern syntax used by URLPattern is similar to the syntax used bypath-to-regexp