fix(codegen): narrow generateEndpoints return type

[aryaemami59]

Summary

• Follow-up to the suggestion by @issy in codegen: Add exactOperationIds option to generateEndpoints config #5174.
• Adds function overloads to generateEndpoints so the return type narrows based on whether outputFile is provided:
  • Without outputFile → Promise<string>
  • With outputFile → Promise<void>

This eliminates the need for manual type assertions like await generateEndpoints(...) as string in consumer code.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[netlify]

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	bcc6556
🔍 Latest deploy log	https://app.netlify.com/projects/redux-starter-kit-docs/deploys/69b2589031dfee000871ea94
😎 Deploy Preview	https://deploy-preview-5237--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit bcc6556:

Sandbox	Source
@examples-query-react/basic	Configuration
@examples-query-react/advanced	Configuration
@examples-action-listener/counter	Configuration
rtk-esm-cra	Configuration

[Copilot]

Pull request overview

This PR is a follow-up change in @rtk-query/codegen-openapi to improve the TypeScript ergonomics of generateEndpoints by narrowing its return type based on whether outputFile is provided, eliminating the need for consumer-side type assertions.

Changes:

• Add overload signatures for generateEndpoints to return Promise<string> when outputFile is omitted, and Promise<void> when outputFile is provided.
• Add runtime + type-level tests validating the new narrowing behavior (including *.test-d.ts typecheck coverage).
• Update Vitest-related dependencies / configuration to support the added typecheck tests.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
yarn.lock	Updates Vitest (and related deps) used by the repo/test setup.
packages/rtk-query-codegen-openapi/vitest.config.mts	Adjusts Vitest config (including enabling typecheck) to support the new type tests.
packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts	Adds runtime assertions for returned value shape with/without outputFile.
packages/rtk-query-codegen-openapi/test/generateEndpoints.test-d.ts	Adds type-level tests asserting overload-based return type narrowing.
packages/rtk-query-codegen-openapi/src/index.ts	Introduces the overload signatures for generateEndpoints.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.