Add additional JSDoc comments to commonly used APIs for better API reference and in-editor documentation. #12975
Conversation
This file contains 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
…ference and in-editor documentation.
brophdawg11
reviewed
Feb 7, 2025
| @@ -109,11 +114,31 @@ type _CreateActionData<ServerActionData, ClientActionData> = Awaited< | |||
| > | |||
|
|
|||
| type ClientDataFunctionArgs<T extends RouteInfo> = { | |||
| /** A {@link https://developer.mozilla.org/en-US/docs/Web/API/Request Fetch Request instance} which you can use to read headers (like cookies, and {@link https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams URLSearchParams} from the request. */ | |||
There was a problem hiding this comment.
Since this is a request created on the client it won't have the same headers/cookie access the server request has. We should either call that out or just don't specifically mention those and instead refer to the commonly used client-side aspects like request.url
There was a problem hiding this comment.
Hmm... This type is used as the basis for ServerDataFunctionArgs. Does it make sense to define request separately on both of them so the docs can be specific to each?
Also, do you know what properties would be available on request for client data functions? I can't seem to find the place where the request object is generated for client data functions.
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.
Many of the comments were pulled from the Remix documentation, adjusted as I thought was necessary. There might be some nuance that I missed, but I think I got it all right.