Fix TypeScript errors in endpoints.mdx code snippets#14181
Open
ArmandPhilippot wants to merge 5 commits into
Open
Fix TypeScript errors in endpoints.mdx code snippets#14181ArmandPhilippot wants to merge 5 commits into
endpoints.mdx code snippets#14181ArmandPhilippot wants to merge 5 commits into
Conversation
Contributor
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
endpoints.mdx code snippets
|
Preview deployment ✅ Deployment complete!
|
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.
Description (required)
Follow-up of #14089. TL;DR: Improve UX by preventing the appearance of red squiggles (TS) and visual changes (formatting with Astro extension) when the user copies and pastes the code snippet.
Fixes code snippets in
guides/endpoints.mdx:params.idisstring | undefinedandundefined"cannot be used as an index type". If we narrow the type tostring(usingAPIRoutetype parameters), TypeScript complains because a string can't be used for index access...Number()might not be the best (NaN) but it's the easier fix to make it TS friendly.satisfies APIRoute, TypeScript complains about the destructured properties.Bufferand, unlikeprocess.env, there is no clues in the editor to fix this, adding a comment might be helpfulRelated issues & labels (optional)