|
10 | 10 | </signature> |
11 | 11 | <signature> |
12 | 12 | <added>1.0</added> |
13 | | - <argument name="settings" type="Map"> |
| 13 | + <argument name="settings" type="Map" optional="true"> |
14 | 14 | <desc>A set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with <a href="/jQuery.ajaxSetup">$.ajaxSetup()</a>.</desc> |
15 | | - <option default="depends on DataType" name="accepts" type="Map"> |
| 15 | + <option default="depends on DataType" name="accepts" type="PlainObject"> |
16 | 16 | <desc>The content type sent in the request header that tells the server what kind of response it will accept in return. If the <code>accepts</code> setting needs modification, it is recommended to do so once in the <code>$.ajaxSetup()</code> method.</desc> |
17 | 17 | </option> |
18 | 18 | <option default="true" name="async" type="Boolean"> |
|
27 | 27 | <option name="complete(jqXHR, textStatus)" type="Function, Array"> |
28 | 28 | <desc>A function to be called when the request finishes (after <code>success</code> and <code>error</code> callbacks are executed). The function gets passed two arguments: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request (<code>"success"</code>, <code>"notmodified"</code>, <code>"error"</code>, <code>"timeout"</code>, <code>"abort"</code>, or <code>"parsererror"</code>). <strong>As of jQuery 1.5</strong>, the <code>complete</code> setting can accept an array of functions. Each function will be called in turn. This is an <a href='http://docs.jquery.com/Ajax_Events'>Ajax Event</a>.</desc> |
29 | 29 | </option> |
30 | | - <option name="contents" type="Map" added="1.5"> |
| 30 | + <option name="contents" type="PlainObject" added="1.5"> |
31 | 31 | <desc>A map of string/regular-expression pairs that determine how jQuery will parse the response, given its content type.</desc> |
32 | 32 | </option> |
33 | 33 | <option default="'application/x-www-form-urlencoded'" name="contentType" type="String"> |
|
41 | 41 | $(this).addClass("done"); |
42 | 42 | });</pre></desc> |
43 | 43 | </option> |
44 | | - <option name="converters" type="Map" default='{"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}' added="1.5"> |
| 44 | + <option name="converters" type="PlainObject" default='{"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}' added="1.5"> |
45 | 45 | <desc>A map of dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response.</desc> |
46 | 46 | </option> |
47 | 47 | <option name="crossDomain" type="Boolean" default="false for same-domain requests, true for cross-domain requests" added="1.5"> |
|
72 | 72 | <option default="true" name="global" type="Boolean"> |
73 | 73 | <desc>Whether to trigger global Ajax event handlers for this request. The default is <code>true</code>. Set to <code>false</code> to prevent the global handlers like <code>ajaxStart</code> or <code>ajaxStop</code> from being triggered. This can be used to control various <a href='http://docs.jquery.com/Ajax_Events'>Ajax Events</a>.</desc> |
74 | 74 | </option> |
75 | | - <option name="headers" type="Map" default="{}" added="1.5"> |
| 75 | + <option name="headers" type="PlainObject" default="{}" added="1.5"> |
76 | 76 | <desc>A map of additional header key/value pairs to send along with the request. This setting is set before the <code>beforeSend</code> function is called; therefore, any values in the headers setting can be overwritten from within the <code>beforeSend</code> function.</desc> |
77 | 77 | </option> |
78 | 78 | <option default="false" name="ifModified" type="Boolean"> |
|
99 | 99 | <option name="scriptCharset" type="String"> |
100 | 100 | <desc>Only for requests with "jsonp" or "script" dataType and "GET" type. Forces the request to be interpreted as a certain charset. Only needed for charset differences between the remote and local content.</desc> |
101 | 101 | </option> |
102 | | - <option name="statusCode" type="Map" default="{}" added="1.5"> |
| 102 | + <option name="statusCode" type="PlainObject" default="{}" added="1.5"> |
103 | 103 | <desc> |
104 | 104 | <p>A map of numeric HTTP codes and functions to be called when the response has the corresponding code. For example, the following will alert when the response status is a 404:</p> |
105 | 105 | <pre>$.ajax({ |
|
133 | 133 | <option name="xhr" type="Function" default="ActiveXObject when available (IE), the XMLHttpRequest otherwise"> |
134 | 134 | <desc>Callback for creating the XMLHttpRequest object. Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise. Override to provide your own implementation for XMLHttpRequest or enhancements to the factory.</desc> |
135 | 135 | </option> |
136 | | - <option name="xhrFields" type="Map" added="1.5.1"> |
| 136 | + <option name="xhrFields" type="PlainObject" added="1.5.1"> |
137 | 137 | <desc><p>A map of fieldName-fieldValue pairs to set on the native <code><abbr title="XMLHttpRequest">XHR</abbr></code> object. For example, you can use it to set <code>withCredentials</code> to <code>true</code> for cross-domain requests if needed. |
138 | 138 | <pre>$.ajax({ |
139 | 139 | url: a_cross_domain_url, |
|
0 commit comments