Changed "Hash" to "Map" in docs

[jquery.git] / src / ajax / ajax.js

diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js
index b6a18f4..45159a5 100644 (file)
--- a/src/ajax/ajax.js
+++ b/src/ajax/ajax.js
@@ -11,7 +11,7 @@ jQuery.fn.extend({
         * @name loadIfModified
         * @type jQuery
         * @param String url The URL of the HTML file to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @param Map params (optional) Key/value pairs that will be sent to the server.
         * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
         * @cat AJAX
         */
@@ -23,6 +23,7 @@ jQuery.fn.extend({
         * Load HTML from a remote file and inject it into the DOM.
         *
         * Note: Avoid to use this to load scripts, instead use $.getScript.
+        * IE strips script tags when there aren't any other characters in front of it.
         *
         * @example $("#feeds").load("feeds.html");
         * @before <div id="feeds"></div>
@@ -274,7 +275,7 @@ jQuery.extend({
         * @name $.get
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @param Map params (optional) Key/value pairs that will be sent to the server.
         * @param Function callback (optional) A function to be executed whenever the data is loaded.
         * @cat AJAX
         */
@@ -315,7 +316,7 @@ jQuery.extend({
         * @name $.getIfModified
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @param Map params (optional) Key/value pairs that will be sent to the server.
         * @param Function callback (optional) A function to be executed whenever the data is loaded.
         * @cat AJAX
         */
@@ -363,7 +364,7 @@ jQuery.extend({
         * @name $.getJSON
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @param Map params (optional) Key/value pairs that will be sent to the server.
         * @param Function callback A function to be executed whenever the data is loaded.
         * @cat AJAX
         */
@@ -392,7 +393,7 @@ jQuery.extend({
         * @name $.post
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @param Map params (optional) Key/value pairs that will be sent to the server.
         * @param Function callback (optional) A function to be executed whenever the data is loaded.
         * @cat AJAX
         */
@@ -419,6 +420,8 @@ jQuery.extend({
         * You can manually abort requests with the XMLHttpRequest's (returned by
         * all ajax functions) abort() method.
         *
+        * Deprecated. Use $.ajaxSetup instead.
+        *
         * @example $.ajaxTimeout( 5000 );
         * @desc Make all AJAX requests timeout after 5 seconds.
         *
@@ -428,18 +431,33 @@ jQuery.extend({
         * @cat AJAX
         */
        ajaxTimeout: function(timeout) {
-               //jQuery.timeout = timeout;
                jQuery.ajaxSettings.timeout = timeout;
        },
        
+       /**
+        * Setup global settings for AJAX requests.
+        *
+        * See $.ajax for a description of all available options.
+        *
+        * @example $.ajaxSetup( {
+        *   url: "/xmlhttp/",
+        *   global: false,
+        *   type: "POST"
+        * } );
+        * $.ajax({ data: myData });
+        * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
+        * disables global handlers and uses POST instead of GET. The following
+        * AJAX requests then sends some data without having to set anything else.
+        *
+        * @name $.ajaxSetup
+        * @type undefined
+        * @param Map settings Key/value pairs to use for all AJAX requests
+        * @cat AJAX
+        */
        ajaxSetup: function(settings) {
                jQuery.extend(jQuery.ajaxSettings, settings);
        },
 
-       // Last-Modified header cache for next request
-       lastModified: {},
-       
-       // TODO document me
        ajaxSettings: {
                global: true,
                type: "GET",
@@ -448,6 +466,9 @@ jQuery.extend({
                processData: true,
                async: true
        },
+       
+       // Last-Modified header cache for next request
+       lastModified: {},
 
        /**
         * Load a remote page using an HTTP request.
@@ -565,8 +586,9 @@ jQuery.extend({
         * 
         * @name $.ajax
         * @type XMLHttpRequest
-        * @param Hash prop A set of properties to initialize the request with.
+        * @param Map properties Key/value pairs to initialize the request with.
         * @cat AJAX
+        * @see ajaxSetup(Map)
         */
        ajax: function( s ) {
                // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
@@ -696,6 +718,10 @@ jQuery.extend({
                        jQuery.handleError(s, xml, null, e);
                }
                
+               // firefox 1.5 doesn't fire statechange for sync requests
+               if(!s.async)
+                       onreadystatechange();
+               
                // return XMLHttpRequest to allow aborting the request etc.
                return xml2;
        },