HtmxAjaxHelperContext typedef should have all optional fields#2701
Merged
1cg merged 2 commits intobigskysoftware:devfrom Jul 8, 2024
Merged
HtmxAjaxHelperContext typedef should have all optional fields#27011cg merged 2 commits intobigskysoftware:devfrom
1cg merged 2 commits intobigskysoftware:devfrom
Conversation
anentropic
commented
Jul 6, 2024
Collaborator
Since the code changes here only affect the JSDoc thus the "code's documentation" + it comes from the same source issue/discussion, I would say it's totally fine. Though, could you please :
|
f358a29 to
22893ab
Compare
Contributor
Author
Thanks, have made those changes. |
kubeden
pushed a commit
to kubeden/htmx
that referenced
this pull request
Jul 11, 2024
…software#2701) * all fields of HtmxAjaxHelperContext should be optional * update docs for htmx.ajax to describe purpose of source field in context
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
The typedef is currently more strict than the code, and prevents IMHO the most useful way to configure ajax requests.
I also added a clarification to the
htmx.ajaxdocs about what specifyingsourcein the context object actually does.See discussion here:
#2698
Testing
Please explain how you tested this change manually, and, if applicable, what new tests you added. If
you're making a change to just the website, you can omit this section.
Checklist
masterfor website changes,devforsource changes)
...oh, do the docs and code changes need to be in separate PRs?
approved via an issue
npm run test) and verified that it succeeded