Skip to content

Commit b7ec850

Browse files
gibson042mgol
authored andcommitted
jQuery.ajax: Improve the jqXHR properties/methods documentation
* Alphabetize properties and methods * Add missing methods and parameters * Clarify getAllResponseHeaders * Standardize formatting * Document getResponseHeader argument Fixes jquerygh-1019 Closes jquerygh-1020
1 parent de99983 commit b7ec850

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

entries/jQuery.ajax.xml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -280,25 +280,32 @@ jqxhr.always(function() {
280280
<li>
281281
<code>readyState</code>
282282
</li>
283+
<li>
284+
<code>responseXML</code> and/or <code>responseText</code> when the underlying request responded with xml and/or text, respectively
285+
</li>
283286
<li>
284287
<code>status</code>
285288
</li>
286289
<li>
287290
<code>statusText</code>
288291
</li>
289-
<li><code>responseXML</code> and/or <code>responseText</code> when the underlying request responded with xml and/or text, respectively</li>
290-
<li><code>setRequestHeader(name, value)</code> which departs from the standard by replacing the old value with the new one rather than concatenating the new value to the old one</li>
291292
<li>
292-
<code>getAllResponseHeaders()</code>
293+
<code>abort( [ statusText ] )</code>
294+
</li>
295+
<li>
296+
<code>getAllResponseHeaders()</code> as a string
297+
</li>
298+
<li>
299+
<code>getResponseHeader( name )</code>
293300
</li>
294301
<li>
295-
<code>getResponseHeader()</code>
302+
<code>overrideMimeType( mimeType )</code>
296303
</li>
297304
<li>
298-
<code>statusCode()</code>
305+
<code>setRequestHeader( name, value )</code> which departs from the standard by replacing the old value with the new one rather than concatenating the new value to the old one
299306
</li>
300307
<li>
301-
<code>abort()</code>
308+
<code>statusCode( callbacksByStatusCode )</code>
302309
</li>
303310
</ul>
304311
<p>No <code>onreadystatechange</code> mechanism is provided, however, since <code>done</code>, <code>fail</code>, <code>always</code>, and <code>statusCode</code> cover all conceivable requirements.</p>

0 commit comments

Comments
 (0)