Merge pull request #2426 from borisyankov/def/jquery

expand the `abort` jsdoc
This commit is contained in:
Basarat Ali Syed
2014-06-28 23:13:30 +10:00
2 changed files with 9 additions and 1 deletions

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() {

4
jquery/jquery.d.ts vendored
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;
/**