docs: clarify TypeScript plugin styles#294
Open
barry166 wants to merge 1 commit into
Open
Conversation
The TypeScript guidance shows callback and async examples but does not explicitly state that mixing async functions with the done callback is invalid. Users hit this after the stricter 4.5.1 typing change, so document the intended split next to the existing examples. Constraint: fastify#221 asks for docs around the 4.5.1 TypeScript behavior Rejected: Add more type examples | the existing examples are enough; the missing piece is the explicit do-not-mix rule Confidence: high Scope-risk: narrow Directive: Keep this guidance aligned with FastifyPluginCallback vs FastifyPluginAsync semantics Tested: npm test; npm run lint; git diff --check Not-tested: none
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
1 participant
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
done, while callback plugins should not be declaredasync.Fixes #221.
Verification
npm testnpm run lintgit diff --checkContribution notes