jQuery.get:jQuery.post: Document issues with data: null with 3 params
#1208
+2
−2
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
3 tasks
timmywil
reviewed
Oct 17, 2022
| @@ -15,7 +15,7 @@ | |||
| <argument name="data" type="PlainObject" /> | |||
| <argument name="textStatus" type="String"/> | |||
| <argument name="jqXHR" type="jqXHR"/> | |||
| <desc>A callback function that is executed if the request succeeds. Required if <code>dataType</code> is provided, but you can use <code>null</code> or <a href="/jQuery.noop/"><code>jQuery.noop</code></a> as a placeholder.</desc> | |||
| <desc>A callback function that is executed if the request succeeds. Required if <code>dataType</code> is provided, but you can use <code>null</code> or <a href="/jQuery.noop/"><code>jQuery.noop</code></a> as a placeholder. <strong>NOTE:</strong> In jQuery 3.x and older, when providing a <code>null</code> value for <code>success</code> you also have to provide the <code>data</code> parameter; you can set it to <code>undefined</code>.</desc> | |||
There was a problem hiding this comment.
Can set it to undefined or null right?
There was a problem hiding this comment.
Technically - probably yes - but I'd rather not advertise that. For example, in the success case, you can set it to null but not to undefined to trigger the documented behavior, which makes us treat the undefined value more as "parameter not passed" and null having some extra meanings in some cases.
What do you think?
There was a problem hiding this comment.
idk, it seems inconsistent to recommend null in one place and undefined in another. I'd probably use null, null, dataType myself.
There was a problem hiding this comment.
If we want to document null for the second parameter as well, we'd have to have some tests in jQuery for this. Currently, I believe we have none.
There was a problem hiding this comment.
I added these tests in jquery/jquery#5640. When merged & backported to 3.x-stable, I'll update this PR as well.
There was a problem hiding this comment.
Two more PRs to merge before I return to this API PR:
gibson042
approved these changes
Oct 18, 2022
mgol
force-pushed
the
jquery-get-data-null
branch
3 times, most recently
from
4ee332d to
03bdec9
Compare
mgol
force-pushed
the
jquery-get-data-null
branch
from
03bdec9 to
66abf44
Compare
mgol
force-pushed
the
jquery-get-data-null
branch
from
66abf44 to
d8fa4f5
Compare
mgol
force-pushed
the
jquery-get-data-null
branch
from
d8fa4f5 to
5e558e0
Compare
mgol
added a commit
to mgol/jquery
that referenced
this pull request
Mar 17, 2025
Also, fix `mock.php` formatting to not fail the `jQuery.get( String, null, String )` test in PHP mode. Ref jquerygh-4989 Ref jquery/api.jquery.com#1208
2 tasks
mgol
force-pushed
the
jquery-get-data-null
branch
from
5e558e0 to
05cab6f
Compare
mgol
added a commit
to jquery/jquery
that referenced
this pull request
Mar 31, 2025
Also, fix `mock.php` formatting to not fail the `jQuery.get( String, null, String )` test in PHP mode. Closes gh-5640 Ref gh-4989 Ref jquery/api.jquery.com#1208
mgol
added a commit
to mgol/jquery
that referenced
this pull request
Mar 31, 2025
Also, fix `mock.php` formatting to not fail the `jQuery.get( String, null, String )` test in PHP mode. Ref jquerygh-5640 Ref jquerygh-4989 Ref jquery/api.jquery.com#1208
This was referenced Mar 31, 2025
mgol
added a commit
to mgol/jquery
that referenced
this pull request
Apr 1, 2025
Also, fix `mock.php` formatting to not fail the `jQuery.get( String, null, String )` test in PHP mode. Ref jquerygh-5640 Ref jquerygh-4989 Ref jquery/api.jquery.com#1208
In jQuery 3.x and older, when providing a `null` value for `success` you also have to provide the `data` parameter; you can set it to `undefined`. Document this restriction of `jQuery.get` & `jQuery.post`. Ref jquery/jquery#4989 Ref jquery/jquery#5139
mgol
force-pushed
the
jquery-get-data-null
branch
from
05cab6f to
3c1c919
Compare
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.
In jQuery 3.x and older, when providing a
nullvalue forsuccessyou also have to provide thedataparameter; you can set it toundefined.Document this restriction of
jQuery.get&jQuery.post.Ref jquery/jquery#4989
Ref jquery/jquery#5139