add URLPattern type in DOM or something lib?

[sinoon]

lib Update Request

Configuration Check

My compilation target is ESNEXT and my lib is the default.

Missing / Incorrect Definition

URLPattern is enabled by default in Chrome and Edge version 95 and above.

But TypeScript missing the definition

Sample Code

new window.URLPattern({
    pathname: '/:a/:b',
})

Documentation Link

doc: https://web.dev/urlpattern/

[saschanaz]

Per MDN only Chromium enabled that feature yet. https://developer.mozilla.org/en-US/docs/Web/API/URLPattern#browser_compatibility

[justinfagnani]

It would be really awesome to also get a utility type that produces the correct groups types based on the pattern string. So we could write code like:

const pattern = new URLPattern('/one/:foo', document.baseURI);
const params = pattern.exec('http://localhost/one/bar').pathname.groups;
console.log(params.foo); // no error
console.log(params.bar); // error

[lucacasonato]

Xref denoland/deno#12558

[fregante]

For reference, there's a polyfill that comes with types. You just have to import it without assignments so it's available globally, including the types.

https://github.com/kenchris/urlpattern-polyfill/blob/main/src/types.d.ts

You can alternatively add this line to your global.d.ts to just import its types:

/// <reference types="urlpattern-polyfill" />

[stipsan]

URLPattern is part of Interop 2025, and already implemented with 100% tests passing in Safari Tech Preview.

[cedx]

Also available in the latest Node.js version:
https://nodejs.org/api/url.html#class-urlpattern

[saschanaz]

Safari enabled it two weeks ago, might be a good idea to file a bug in mdn/browser-compat-data which will be reflected here automatically.