Testing type error

[bryanjtc]

Context

What's your version of nuqs?

v2.0.4

What framework are you using?

• ✅ React Router

Which version of your framework are you using?

6.27.0

Description

I'm following the testing example https://nuqs.47ng.com/docs/testing and typescript throws the following errors.

Type '[UrlUpdateEvent]' does not satisfy the constraint 'Procedure'.
  Type '[UrlUpdateEvent]' provides no match for the signature '(...args: any[]): any'

Type 'Mock<[UrlUpdateEvent]>' is not assignable to type '(event: UrlUpdateEvent) => void'.
  Types of parameters 'args' and 'event' are incompatible.
    Type '[event: UrlUpdateEvent]' is not assignable to type 'never'

Reproduction

Follow the testing example
If needed use this tsconfig

tsconfig.json

{
  "compilerOptions": {
    "target": "ESNext",
    "useDefineForClassFields": true,
    "lib": ["DOM", "DOM.Iterable", "ESNext"],
    "allowJs": false,
    "skipLibCheck": true,
    "esModuleInterop": false,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx",
    "verbatimModuleSyntax": false,
    "incremental": true,
    "baseUrl": ".",
    "paths": {
      "~/*": ["./*"]
    }
  },
  "references": [
    {
      "path": "./tsconfig.node.json"
    }
  ]
}

tsconfig.node.json

{
  "compilerOptions": {
    "composite": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "allowSyntheticDefaultImports": true
  },
  "include": ["vite.config.ts", "i18next.d.ts", "change-case.d.ts"]
}

[franky47]

Thanks for the report.

What version of Vitest are you using?

[bryanjtc]

Thanks for the report.

What version of Vitest are you using?

2.1.3

[franky47]

Thanks, I managed to reproduce it here: https://github.com/franky47/nuqs-repro-706

I'll have a look, I see that I'm using Vitest 1 in the nuqs repository, it could be a breaking change on their part.

[franky47]

Ok so the generic types for vi.fn have changed from listing the arguments and return types separately (PR vitest-dev/vitest#4784), to passing the type of the actual function.

So for Vitest 2 you should change the onUrlUpdate spy definition to:

const onUrlUpdate = vi.fn<(event: UrlUpdateEvent) => void>()

[bryanjtc]

That solves it. Tk

[franky47]

🎉 This issue has been resolved in version 2.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release