Merge pull request #2316 from lijunle/jquery-xhr-doc

Add JSDoc for JQueryXHR.abort method.
This commit is contained in:
John Reilly
2014-06-27 18:08:43 +01:00
+3
View File
@@ -167,6 +167,9 @@ interface JQueryXHR extends XMLHttpRequest, JQueryPromise<any> {
* The .overrideMimeType() method may be used in the beforeSend() callback function, for example, to modify the response content-type header. As of jQuery 1.5.1, the jqXHR object also contains the overrideMimeType() method (it was available in jQuery 1.4.x, as well, but was temporarily removed in jQuery 1.5).
*/
overrideMimeType(mimeType: string): any;
/**
* Cancel the request. Pass the statusText as textStatus parameter for done callback, "canceled" will be passed if not provided.
*/
abort(statusText?: string): void;
/**
* Incorporates the functionality of the .done() and .fail() methods, allowing (as of jQuery 1.8) the underlying Promise to be manipulated. Refer to deferred.then() for implementation details.