jQuery.get:jQuery.post: Document issues with data: null with 3 params
#1208
Conversation
| @@ -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.
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
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
d8fa4f5 to
5e558e0
Compare
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