expand the abort jsdoc

This commit is contained in:
basarat
2014-06-28 23:08:51 +10:00
parent 32369dce43
commit 593a1d571b
2 changed files with 9 additions and 1 deletions
+6
View File
@@ -193,6 +193,12 @@ function test_ajax() {
}, (jqXHR, textStatus, errorThrown) => {
console.log(jqXHR, textStatus, errorThrown);
});
// jqXHR object
var jqXHR = $.ajax({
url: "test.js"
});
jqXHR.abort('aborting because I can');
}
function test_ajaxComplete() {
+3 -1
View File
@@ -168,7 +168,9 @@ interface JQueryXHR extends XMLHttpRequest, JQueryPromise<any> {
*/
overrideMimeType(mimeType: string): any;
/**
* Cancel the request. Pass the statusText as textStatus parameter for done callback, "canceled" will be passed if not provided.
* Cancel the request.
*
* @param statusText A string passed as the textStatus parameter for the done callback. Default value: "canceled"
*/
abort(statusText?: string): void;
/**