HaxeFoundation.haxe/std/js/jquery/Deferred.hx

/* This file is generated, do not edit! Visit http://api.jquery.com/ for API documentation. */
package js.jquery;
@:native("$.Deferred") extern class Deferred {
	/**
		Add handlers to be called when the Deferred object is either resolved or rejected.
	**/
	public function always(alwaysCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>, ?alwaysCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>):js.jquery.Deferred;
	/**
		Add handlers to be called when the Deferred object is resolved.
	**/
	public function done(doneCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>, ?doneCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>):js.jquery.Deferred;
	/**
		Add handlers to be called when the Deferred object is rejected.
	**/
	public function fail(failCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>, ?failCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, Array<haxe.Constraints.Function>>):js.jquery.Deferred;
	/**
		A factory function that returns a chainable utility object with methods to register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.
	**/
	@:selfCall
	public function new(?beforeStart:js.jquery.Deferred -> Void):Void;
	/**
		Call the progressCallbacks on a Deferred object with the given <code>args</code>.
	**/
	public function notify(args:Dynamic):js.jquery.Deferred;
	/**
		Call the progressCallbacks on a Deferred object with the given context and <code>args</code>.
	**/
	public function notifyWith(context:Dynamic, ?args:Array<Dynamic>):js.jquery.Deferred;
	/**
		Utility method to filter and/or chain Deferreds.
	**/
	@:overload(function(?doneFilter:haxe.Constraints.Function, ?failFilter:haxe.Constraints.Function, ?progressFilter:haxe.Constraints.Function):js.jquery.Promise { })
	public function pipe(?doneFilter:haxe.Constraints.Function, ?failFilter:haxe.Constraints.Function):js.jquery.Promise;
	/**
		Add handlers to be called when the Deferred object generates progress notifications.
	**/
	public function progress(progressCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, haxe.extern.EitherType<Array<Dynamic>, Array<haxe.Constraints.Function>>>, ?progressCallbacks:haxe.extern.EitherType<haxe.Constraints.Function, haxe.extern.EitherType<Array<Dynamic>, Array<haxe.Constraints.Function>>>):js.jquery.Deferred;
	/**
		Return a Deferred's Promise object.
	**/
	public function promise(?target:Dynamic):js.jquery.Promise;
	/**
		Reject a Deferred object and call any failCallbacks with the given <code>args</code>.
	**/
	public function reject(?args:Dynamic):js.jquery.Deferred;
	/**
		Reject a Deferred object and call any failCallbacks with the given <code>context</code> and <code>args</code>.
	**/
	public function rejectWith(context:Dynamic, ?args:Array<Dynamic>):js.jquery.Deferred;
	/**
		Resolve a Deferred object and call any doneCallbacks with the given <code>args</code>.
	**/
	public function resolve(?args:Dynamic):js.jquery.Deferred;
	/**
		Resolve a Deferred object and call any doneCallbacks with the given <code>context</code> and <code>args</code>.
	**/
	public function resolveWith(context:Dynamic, ?args:Array<Dynamic>):js.jquery.Deferred;
	/**
		Determine the current state of a Deferred object.
	**/
	public function state():String;
	/**
		Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.
	**/
	public function then(doneFilter:haxe.Constraints.Function, ?failFilter:haxe.Constraints.Function, ?progressFilter:haxe.Constraints.Function):js.jquery.Promise;
}