Documentation for $.ajaxSetup

This commit is contained in:
Jörn Zaefferer 2006-12-22 14:40:46 +00:00
parent fc84b9db10
commit bfdf836da9
2 changed files with 25 additions and 6 deletions

View file

@ -1,7 +1,7 @@
New and Noteworthy New and Noteworthy
----------------- -----------------
1.0.5 1.0.5/1.1
----- -----
- Fixed synchronous requests - Fixed synchronous requests
@ -13,6 +13,7 @@ New and Noteworthy
- Fixed docs for html(): Now mentions that is not available for XML documents - Fixed docs for html(): Now mentions that is not available for XML documents
- Improved docs for blur() and focus(), mentioning the difference between calling the jQuery method and the DOM method - Improved docs for blur() and focus(), mentioning the difference between calling the jQuery method and the DOM method
- Implemented a better error handling for ajax requests. Exceptions caused by dropping connections are now handled, too. - Implemented a better error handling for ajax requests. Exceptions caused by dropping connections are now handled, too.
- Added global settings for AJAX (in addition to timeout), use $.ajaxSetup() to modify them
1.0.4 1.0.4
----- -----

View file

@ -419,6 +419,8 @@ jQuery.extend({
* You can manually abort requests with the XMLHttpRequest's (returned by * You can manually abort requests with the XMLHttpRequest's (returned by
* all ajax functions) abort() method. * all ajax functions) abort() method.
* *
* Deprecated. Use $.ajaxSetup instead.
*
* @example $.ajaxTimeout( 5000 ); * @example $.ajaxTimeout( 5000 );
* @desc Make all AJAX requests timeout after 5 seconds. * @desc Make all AJAX requests timeout after 5 seconds.
* *
@ -428,18 +430,31 @@ jQuery.extend({
* @cat AJAX * @cat AJAX
*/ */
ajaxTimeout: function(timeout) { ajaxTimeout: function(timeout) {
//jQuery.timeout = timeout;
jQuery.ajaxSettings.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"
* } );
* @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
* disables global handlers and uses POST instead of GET
*
* @name $.ajaxSetup
* @type undefined
* @param Object settings Key/value pairs for ajax options
* @cat AJAX
*/
ajaxSetup: function(settings) { ajaxSetup: function(settings) {
jQuery.extend(jQuery.ajaxSettings, settings); jQuery.extend(jQuery.ajaxSettings, settings);
}, },
// Last-Modified header cache for next request
lastModified: {},
// TODO document me
ajaxSettings: { ajaxSettings: {
global: true, global: true,
type: "GET", type: "GET",
@ -449,6 +464,9 @@ jQuery.extend({
async: true async: true
}, },
// Last-Modified header cache for next request
lastModified: {},
/** /**
* Load a remote page using an HTTP request. * Load a remote page using an HTTP request.
* *