feat: update worma example config and fix axios generic type - #177
Merged
Conversation
…nd fix axios generic type - refactor examples/typescript/worma.config.ts to include alova, alovaGlobals, axios, fetch, and ky generator examples with English documentation - fix axios service template generic type from axiosInstance<T> to axiosInstance<unknown, T> for proper response typing
🦋 Changeset detectedLatest commit: 923cf21 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR refactors the worma TypeScript example configuration to showcase all supported HTTP client presets, and fixes a type inference bug in the axios service template where the response type was incorrectly mapped.
Changes
1. Refactor Example Config (
examples/typescript/worma.config.ts)Each preset now has its own section with English comments explaining its purpose:
Additional fixes:
C:/Users/Administrator/Desktop/api-docs.json) with portable relative path (petstore.json)aiDocimport and plugin usage from the old configuration2. Fix Axios Generic Type (
packages/worma/src/template/presets/axios/typescript/services/{tag}.ts.handlebars)Problem
Generated axios service functions produced incorrect type inference. For example:
Root Cause
Axios v1 instance methods use a dual-generic signature:
T→ request body type (first generic)R→ response data type (second generic)T(request body), notR(response)The template was passing only one generic argument, causing the response type to be inferred as the request body type instead:
Fix
By explicitly passing
unknownas the first generic (request body), the second generic correctly maps to the response type, restoring proper type inference:Impact
Files Changed
Testing
To verify the fix, regenerate an axios-based API service and confirm the response type is correctly inferred: