Ajax: Support `null` as success functions in `jQuery.get` #5139

mgol · 2022-10-11T14:30:42Z

Summary

According to the docs, one can use null as a success function in jQuery.get
of jQuery.post so the following:

await jQuery.get( "https://httpbin.org/json", null, "text" )

should get the text result. However, this shortcut hasn't been working so far.

Fixes gh-4989

Checklist

New tests have been added to show the fix or feature works
Grunt build and unit tests pass locally with these changes
If needed, a docs issue/PR was created at https://github.com/jquery/api.jquery.com - API PR: jQuery.get:jQuery.post: Document issues with data: null with 3 params api.jquery.com#1208

mgol · 2022-10-11T14:31:29Z

I added this to the discussion list to discuss whether we want this in 3.x or not. This has a chance of breaking some code; on the other hand, documentation states the behavior from this PR.

According to the docs, one can use `null` as a success function in `jQuery.get` of `jQuery.post` so the following: ```js await jQuery.get( "https://httpbin.org/json", null, "text" ) ``` should get the text result. However, this shortcut hasn't been working so far. Fixes jquerygh-4989

mgol · 2022-10-15T08:54:56Z

src/ajax.js

-		if ( typeof data === "function" ) {
+		// Shift arguments if data argument was omitted.
+		// Handle the null callback placeholder.
+		if ( typeof data === "function" || data === null ) {


@gibson042 allowing undefined here would break the 4-param signature with the second parameter (data) being undefined which is e.g. used in the $.getScript definition. We could add more checks to make it work but I thought in that case it may be better to just allow null. null is not an allowed data value so we don’t have a conflict.

mgol · 2022-10-15T08:56:06Z

src/ajax/xhr.js

@@ -15,7 +15,6 @@ var xhrSuccessStatus = {
 jQuery.ajaxTransport( function( options ) {
 	var callback;

-	// Cross domain only allowed if supported through XMLHttpRequest


This is unrelated but this comment has long been invalid… We only have support checks on 3.x-stable here.

gibson042 · 2022-10-17T16:13:18Z

src/ajax.js

-		if ( typeof data === "function" ) {
+		// Shift arguments if data argument was omitted.
+		// Handle the null callback placeholder.
+		if ( typeof data === "function" || data === null ) {


timmywil · 2022-10-17T16:23:59Z

Since this has been like this for so long, we're going to leave 3.x unchanged and fix this for 4.0.

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 · 2022-10-17T16:53:48Z

I submitted the API PR at 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

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`. Closes jquerygh-1208 Ref jquery/jquery#4989 Ref jquery/jquery#5139 Ref jquery/jquery#5640 Ref jquery/jquery#5645 Ref jquery/jquery#5646

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`. Closes gh-1208 Ref jquery/jquery#4989 Ref jquery/jquery#5139 Ref jquery/jquery#5640 Ref jquery/jquery#5645 Ref jquery/jquery#5646

mgol added Ajax Needs review Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. labels Oct 11, 2022

mgol added this to the 4.0.0 milestone Oct 11, 2022

mgol self-assigned this Oct 11, 2022

mgol mentioned this pull request Oct 11, 2022

Null value in jQuery.get doesn't allow use of dataType #4989

Closed

mgol marked this pull request as draft October 11, 2022 14:41

mgol removed Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. Needs review labels Oct 11, 2022

mgol force-pushed the get-null-success-fn branch from d75d41e to aa17bef Compare October 15, 2022 08:33

mgol changed the title ~~Ajax: Support null & undefined as success functions in jQuery.get~~ Ajax: Support null as success functions in jQuery.get Oct 15, 2022

mgol added Needs review Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. labels Oct 15, 2022

mgol marked this pull request as ready for review October 15, 2022 08:33

mgol commented Oct 15, 2022

View reviewed changes

gibson042 approved these changes Oct 17, 2022

View reviewed changes

timmywil removed the Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. label Oct 17, 2022

mgol removed the Needs review label Oct 17, 2022

mgol mentioned this pull request Oct 17, 2022

jQuery.get:jQuery.post: Document issues with data: null with 3 params jquery/api.jquery.com#1208

Merged

mgol merged commit 74978b7 into jquery:main Oct 17, 2022

mgol deleted the get-null-success-fn branch October 17, 2022 16:54

dmethvin mentioned this pull request Mar 2, 2024

jQuery.get() 4.0 backward compatibility issue #5426

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ajax: Support `null` as success functions in `jQuery.get` #5139

Ajax: Support `null` as success functions in `jQuery.get` #5139

Ajax: Support null as success functions in jQuery.get #5139

Ajax: Support null as success functions in jQuery.get #5139

Conversation

Summary

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ajax: Support `null` as success functions in `jQuery.get` #5139

Ajax: Support `null` as success functions in `jQuery.get` #5139