Unable to overwrite command with TS overloads

Current behavior

Given I override visit command as below:

Cypress.Commands.overwrite('visit', (originalFn, url, options) => {
  // do something with URL as string
  const char = url.includes('?')

  return originalFn(url, options);
});

I’m unable to type this:

Cypress.Commands.overwrite<'visit'>('visit', (originalFn, url, options?: Partial<VisitOptions>) => {
    // do something with URL as string
  const char = url.includes('?') // TS2339: Property 'includes' does not exist on type 'Partial  & { url: string; }'

  return originalFn(url, options); // TS2554: Expected 1 arguments, but got 2.
});

… as cy.visit is defined with two type overloads, but only the latter one is taken into account:

    visit(url: string, options?: Partial<VisitOptions>): Chainable<AUTWindow>
    visit(options: Partial<VisitOptions> & { url: string }): Chainable<AUTWindow>

Desired behavior

I’m able to override visit command and use visit(url: string, options?: Partial<VisitOptions>): Chainable<AUTWindow> variant.

Test code to reproduce

Cypress.Commands.overwrite<'visit'>('visit', (originalFn, url, options?: Partial<VisitOptions>) => {
    // do something with URL as string
  const char = url.includes('?') // TS2339: Property 'includes' does not exist on type 'Partial  & { url: string; }'

  return originalFn(url, options); // TS2554: Expected 1 arguments, but got 2.
});

Cypress Version

9.2.0

Other

No response

[edufarre]

Do we have any updates on this? I am using the version 9.5.0 and I am still having this issue when trying to Cypress.Commands.overwrite the original visit command

[dclowd9901]

One workaround for this that we used until the Cypress devs release a fix was simply swapping the visit function types in our own type definition file:

declare namespace Cypress {
  interface Chainable {
    ...
    visit(
      options: Partial<Cypress.VisitOptions & PopulatePreloadsOptions> & { url: string }
    ): Cypress.Chainable<Cypress.AUTWindow>;
    visit(
      url: string,
      options?: Partial<Cypress.VisitOptions & PopulatePreloadsOptions>
    ): Cypress.Chainable<Cypress.AUTWindow>;
    ...
  }
}

It’s janky, but at least we still get type assertions.

Does anyone know what the canonical way to resolve something like this in Typescript? It seems like it’s probably not solvable using the string literal generic mechanism for overwrite. Maybe a predicate?

Edit: Looks like it goes back to this question: https://github.com/microsoft/TypeScript/issues/47540