Built-in URL is not compatible with @types/node URL

[noahbald]

⚙ Compilation target

es6

⚙ Library

lib.dom.d.ts

Missing / Incorrect Definition

I get an error after updating from 5.5.4 -> 5.6.2 because the builtin URL is not longer compatible with node's URL. This is problematic because the builtin URL and node's URL are often used interchangeably.
Even if their types aren't strictly the same, I'd normally expect there not to be an error when using one in place of the other.

In the following example, the line where we use new URL(origin) has an error because import("url") doesn't match the builtin URL.
Perhaps the typing of @types/node need to be updated?

error TS2345: Argument of type 'string | import("url").URL' is not assignable to parameter of type 'string | URL'.
  Type 'URL' is not assignable to type 'string | URL'.
    Type 'import("url").URL' is not assignable to type 'URL'.
      The types returned by 'searchParams.entries()' are incompatible between these types.
        Type 'IterableIterator<[string, string]>' is missing the following properties from type 'URLSearchParamsIterator<[string, string]>': map, filter, take, drop, and 9 more.

Sample Code

// agent.ts
import { URL } from 'url';

export function agent(url: URL | string) {/* ... */};

// factory.ts
const createAgent = (origin: Parameters<typeof agent>[0]) => {
  const { protocol } = new URL(origin);
  // ...
}

Documentation Link

This was probably introduces as part of the strict iterator checks
https://devblogs.microsoft.com/typescript/announcing-typescript-5-6/#strict-builtin-iterator-checks-(and---strictbuiltiniteratorreturn)