jQuery ajaxSetup()

Introduction

Set the default URL and success function for all AJAX requests:

View in separate window

<!DOCTYPE html>
<html>
<head>
<script 
 src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js">
</script>/*from  ww  w  . j  a  v  a2  s .  c  om*/
<script>
$(document).ready(function(){
  $("button").click(function(){
    $.ajaxSetup({url: "ajax.txt", success: function(result){
      $("div").html(result);}});
    $.ajax();
  });
});
</script>
</head>
<body>

<div><h2>Here</h2></div>

<button>Change Content</button>

</body>
</html>

The ajaxSetup() method sets default values for future AJAX requests.

$.ajaxSetup({name:value, name:value, ... })

The parameters sets the settings for AJAX requests with one or more name/value pairs.

Possible names/values in the table below:

Name Value Description
async A Boolean value whether the request should be handled asynchronous or not. Default is true
beforeSend(xhr)A function run before the request is sent
cache A Boolean value whether the browser should cache the requested pages. Default is true
complete(xhr,status) A function run when the request is finished after success and error functions
contentTypeA string content type used when sending data to the server. Default is: "application/x-www-form-urlencoded"
contextThis contextthe "this" value for all AJAX related callback functions
data Object data to be sent to the server
dataFilter(data,type) A functionhandle the raw response data of the XMLHttpRequest
dataType A stringThe data type expected of the server response.
error(xhr,status,error)A function run if the request fails.
global A Boolean value whether or not to trigger global AJAX event handles for the request. Default is true
ifModified A Boolean value whether a request is only successful if the response has changed since the last request. Default is: false.
jsonp A string overriding the callback function in a jsonp request
jsonpCallback A string a name for the callback function in a jsonp request
password A string a password to be used in an HTTP access authentication request.
processDataA Boolean value whether or not data sent with the request should be transformed into a query string. Default is true
scriptCharset A string the charset for the request
success(result,status,xhr) A function run when the request succeeds
timeoutA number The local timeout in milliseconds for the request
traditionalA Boolean valuewhether or not to use the traditional style of param serialization
type A string the type of request. (GET or POST)
urlA string the URL to send the request to. Default is the current page
username A stringa username to be used in an HTTP access authentication request
xhrA function for creating the XMLHttpRequest object



PreviousNext

Related