Jquery Ajax Options

- 맨날 쓰지만, 간혹 까먹는 옵션들이 하나씩 있어서 아예 정리를 해보고자... 

$.ajax({

// boolean, true|false (true: 비동기(default), false: 동기)

async: true

// boolean, true|false (true: 캐시 함(default, dataType 이 script 일 경우 false), false: 캐시하지않음.)

, cache: true

// string, 호출 URL

, url: '/mypage'

// string, GET|POST 전송 타입 설정

, data: GET

// string, 인증이 필요한 통신 시 이름 입력

, username: 'someone'

// string, 인증이 필요한 통신 시 암호 입력

, password: 'something'

// string

// 서버에 데이터를 보낼 때 사용 content - type 헤더의 값. 

// 기본값은 "application/x-www-form-urlencoded;charset=UTF-8"

, contentType: 'application/x-www-form-urlencoded;charset=UTF-8'

// object or string, 서버로 전송하는 값. 아래 데이터는 GET 방식으로 전달되며. foo=bar&foo2=bar2 처럼도 사용 가능

, data: {

foo: 'bar'

, foo2: 'bar2'

}

// boolean, true|false, default true

// data 개채를 문자열로 변환하여 보낼 것인지 여부.

// default 는 true 이며 'application/x-www-form-urlencoded' 로 전달된다.

// DOM 객체 등으로 보낼 시에는 false 로 설정

, processData: true

// string

/* 

응답 데이터 형식을 지정. 생략했을 경우, jQuery가 MIME 타입 등을 보면서 자동으로 결정.

xml: xml 문서

html: html 문서. script 태그가 포함된 경우 실행.

script: javascript 코드를 text 로. 다른 도메인으로 요청하는 경우 GET 으로 전달된다.

json: json 형식으로 처리 되며 javascript object 로 변환되어 사용가능.

jsonp: jsonp 로 요청 되며 callback 으로 전달받은 응답데이터는 json 으로 사용 가능

text: 일반 텍스트.

**** dataType 을 전송하는 경우 서버에서의 응답도 해당 타입으로 반환하는지 확인하여야 한다.

**** dataType 과 응답 MIME 타입이 다를 경우 문제가 발생 할 수 있다. e.g,. json 으로 요청하였는데 json 데이터가 브라우저에 html text 로 뿌려진다던지...

*/

, dataType: 'json'

// string, 스크립트 로드 시 charset 설정, dataType: jsonp|script 일 시 실행되는 페이지와 호출하는 서버측의 charset 이 다를 경우에 지정

, scriptCharset: 'UTF-8'

// number, 응답 대기 시간

, timeout: 10

// boolean, true|false, 글로벌 이벤트 부여여부. default true.

, global: true

// boolean, true|false, 응답된 헤더의 Last-Modified 상태를 확인하여 변경이 있는 경우에만 성공 상태를 반환

, isModified: false

// json 요청 시 callback 이 아닌 다른 이름으로 사용 시 셋팅. default callback

, jsonp: 'anotherFunction' // 서버측에서도 응답을 anotherFunction(data); 처럼 내려주어야 한다.

// function, XMLHttpRequest 의 응답 데이터를 필터링. 

, dataFilter: function(payload, dataType) {

// 데이터 필터링 필요 시 필터링 후 반환

return data;

}

// function, ajax 요청 전 실행

, beforeSend: function() {

$('#loadingImg').show();

}

// function, success, error 처리 후 실행

, complete: function(xhr, status, text) {

$('#loadingImg').hide();

}

// function, ajax 응답 성공 시 실행

, success: function(payload, status) {

}

// function, ajax 응답 오류 시 실행

, error: function(xhr, status, text) {

}

)};