export as namespace Sizzle; declare const Sizzle: SizzleStatic; export = Sizzle; interface SizzleStatic { selectors: Sizzle.Selectors; >(selector: string, context: Element | Document | DocumentFragment, results: TArrayLike): TArrayLike; (selector: string, context?: Element | Document | DocumentFragment): Element[]; // tslint:disable-next-line:ban-types compile(selector: string): Function; matchSelector(element: Element, selector: string): boolean; matches(selector: string, elements: Element[]): Element[]; } declare namespace Sizzle { interface Selectors { cacheLength: number; match: Selectors.Matches; find: Selectors.FindFunctions; preFilter: Selectors.PreFilterFunctions; filter: Selectors.FilterFunctions; attrHandle: Selectors.AttrHandleFunctions; pseudos: Selectors.PseudoFunctions; setFilters: Selectors.SetFilterFunctions; createPseudo(fn: Selectors.CreatePseudoFunction): Selectors.PseudoFunction; } namespace Selectors { interface Matches { [name: string]: RegExp; } interface FindFunction { (match: RegExpMatchArray, context: Element | Document, isXML: boolean): Element[] | void; } interface FindFunctions { [name: string]: FindFunction; } interface PreFilterFunction { (match: RegExpMatchArray): string[]; } interface PreFilterFunctions { [name: string]: PreFilterFunction; } interface FilterFunction { (element: string, ...matches: string[]): boolean; } interface FilterFunctions { [name: string]: FilterFunction; } interface AttrHandleFunction { (elem: any, casePreservedName: string, isXML: boolean): string; } interface AttrHandleFunctions { [name: string]: AttrHandleFunction; } interface PseudoFunction { (elem: Element): boolean; } interface PseudoFunctions { [name: string]: PseudoFunction; } interface SetFilterFunction { (elements: Element[], argument: number, not: boolean): Element[]; } interface SetFilterFunctions { [name: string]: SetFilterFunction; } interface CreatePseudoFunction { (...args: any[]): PseudoFunction; } } } // tslint:disable:jsdoc-format // tslint:disable:max-line-length // tslint:disable:no-irregular-whitespace interface JQuery extends Iterable { /** * A string containing the jQuery version number. * @see \`{@link https://api.jquery.com/jquery-2/#jquery1 }\` * @since 1.0 * @example ​ ````Determine if an object is a jQuery object ```javascript var a = { what: "A regular JS object" }, b = $( "body" ); ​ if ( a.jquery ) { // Falsy, since it's undefined alert( "a is a jQuery object!" ); } ​ if ( b.jquery ) { // Truthy, since it's a string alert( "b is a jQuery object!" ); } ``` * @example ​ ````Get the current version of jQuery running on the page ```javascript alert( "You are running jQuery version: " + $.fn.jquery ); ``` */ jquery: string; /** * The number of elements in the jQuery object. * @see \`{@link https://api.jquery.com/length/ }\` * @since 1.0 * @example ​ ````Count the divs. Click to add more. ```html length demo
​ ``` */ length: number; /** * Create a new jQuery object with elements added to the set of matched elements. * @param selector A string representing a selector expression to find additional elements to add to the set of matched elements. * @param context The point in the document at which the selector should begin matching; similar to the context * argument of the $(selector, context) method. * @see \`{@link https://api.jquery.com/add/ }\` * @since 1.4 */ add(selector: JQuery.Selector, context: Element): this; // TODO: The return type should reflect newly selected types. /** * Create a new jQuery object with elements added to the set of matched elements. * @param selector_elements_html_selection _@param_ `selector_elements_html_selection` *
* * `selector` — A string representing a selector expression to find additional elements to add to the set of matched elements.
* * `elements` — One or more elements to add to the set of matched elements.
* * `html` — An HTML fragment to add to the set of matched elements.
* * `selection` — An existing jQuery object to add to the set of matched elements. * @see \`{@link https://api.jquery.com/add/ }\` * @since 1.0 * @since 1.3.2 * @example ​ ````Finds all divs and makes a border. Then adds all paragraphs to the jQuery object to set their backgrounds yellow. ```html add demo

Added this... (notice no border)

​ ``` * @example ​ ````Adds more elements, matched by the given expression, to the set of matched elements. ```html add demo

Hello

Hello Again ​ ``` * @example ​ ````Adds more elements, created on the fly, to the set of matched elements. ```html add demo

Hello

​ ``` * @example ​ ````Adds one or more Elements to the set of matched elements. ```html add demo

Hello

Hello Again ​ ``` * @example ​ ````Demonstrates how to add (or push) elements to an existing collection ```html add demo

Hello

Hello Again ​ ``` */ add(selector_elements_html_selection: JQuery.Selector | JQuery.TypeOrArray | JQuery.htmlString | JQuery | JQuery.Node): this; /** * Add the previous set of elements on the stack to the current set, optionally filtered by a selector. * @param selector A string containing a selector expression to match the current set of elements against. * @see \`{@link https://api.jquery.com/addBack/ }\` * @since 1.8 * @example ​ ````The .addBack() method causes the previous set of DOM elements in the traversal stack to be added to the current set. In the first example, the top stack contains the set resulting from .find("p"). In the second example, .addBack() adds the previous set of elements on the stack — in this case $("div.after-addback") — to the current set, selecting both the div and its enclosed paragraphs. ```html addBack demo

Before addBack()

First Paragraph

Second Paragraph

After addBack()

First Paragraph

Second Paragraph

​ ``` */ addBack(selector?: JQuery.Selector): this; /** * Adds the specified class(es) to each element in the set of matched elements. * @param className_function _@param_ `className_function` *
* * `className` — One or more space-separated classes to be added to the class attribute of each matched element.
* * `function` — A function returning one or more space-separated class names to be added to the existing class * name(s). Receives the index position of the element in the set and the existing class name(s) as * arguments. Within the function, `this` refers to the current element in the set. * @see \`{@link https://api.jquery.com/addClass/ }\` * @since 1.0 * @since 1.4 * @since 3.3 * @example ​ ````Add the class "selected" to the matched elements. ```html addClass demo

Hello

and

Goodbye

​ ``` * @example ​ ````Add the classes "selected" and "highlight" to the matched elements. ```html addClass demo

Hello

and

Goodbye

​ ``` * @example ​ ````Pass in a function to .addClass() to add the "green" class to a div that already has a "red" class. ```html addClass demo
This div should be white
This div will be green because it now has the "green" and "red" classes. It would be red if the addClass function failed.
This div should be white

There are zero green divs

​ ``` */ addClass(className_function: JQuery.TypeOrArray | ((this: TElement, index: number, currentClassName: string) => string)): this; /** * Insert content, specified by the parameter, after each element in the set of matched elements. * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert after each element in the set of matched elements. * @see \`{@link https://api.jquery.com/after/ }\` * @since 1.0 * @example ​ ````Inserts some HTML after all paragraphs. ```html after demo

I would like to say:

​ ``` * @example ​ ````Inserts a DOM element after all paragraphs. ```html after demo

I would like to say:

​ ``` * @example ​ ````Inserts a jQuery object (similar to an Array of DOM Elements) after all paragraphs. ```html after demo Hello

I would like to say:

​ ``` */ after(...contents: Array>>): this; /** * Insert content, specified by the parameter, after each element in the set of matched elements. * @param function_functionーhtml _@param_ `function_functionーhtml` *
* * `function` — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert * after each element in the set of matched elements. Receives the index position of the element in the * set as an argument. Within the function, `this` refers to the current element in the set.
* * `functionーhtml` — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert * after each element in the set of matched elements. Receives the index position of the element in the * set and the old HTML value of the element as arguments. Within the function, `this` refers to the * current element in the set. * @see \`{@link https://api.jquery.com/after/ }\` * @since 1.4 * @since 1.10 */ after(function_functionーhtml: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; /** * Register a handler to be called when Ajax requests complete. This is an AjaxEvent. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxComplete/ }\` * @since 1.0 * @example ​ ````Show a message when an Ajax request completes. ```javascript $( document ).ajaxComplete(function( event, request, settings ) { $( "#msg" ).append( "
  • Request Complete.
  • " ); }); ``` */ ajaxComplete(handler: (this: Document, event: JQuery.TriggeredEvent, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings) => void | false): this; /** * Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxError/ }\` * @since 1.0 * @example ​ ````Show a message when an Ajax request fails. ```javascript $( document ).ajaxError(function( event, request, settings ) { $( "#msg" ).append( "
  • Error requesting page " + settings.url + "
  • " ); }); ``` */ ajaxError(handler: (this: Document, event: JQuery.TriggeredEvent, jqXHR: JQuery.jqXHR, ajaxSettings: JQuery.AjaxSettings, thrownError: string) => void | false): this; /** * Attach a function to be executed before an Ajax request is sent. This is an Ajax Event. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxSend/ }\` * @since 1.0 * @example ​ ````Show a message before an Ajax request is sent. ```javascript $( document ).ajaxSend(function( event, request, settings ) { $( "#msg" ).append( "
  • Starting request at " + settings.url + "
  • " ); }); ``` */ ajaxSend(handler: (this: Document, event: JQuery.TriggeredEvent, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings) => void | false): this; /** * Register a handler to be called when the first Ajax request begins. This is an Ajax Event. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxStart/ }\` * @since 1.0 * @example ​ ````Show a loading message whenever an Ajax request starts (and none is already active). ```javascript $( document ).ajaxStart(function() { $( "#loading" ).show(); }); ``` */ ajaxStart(handler: (this: Document) => void | false): this; /** * Register a handler to be called when all Ajax requests have completed. This is an Ajax Event. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxStop/ }\` * @since 1.0 * @example ​ ````Hide a loading message after all the Ajax requests have stopped. ```javascript $( document ).ajaxStop(function() { $( "#loading" ).hide(); }); ``` */ ajaxStop(handler: (this: Document) => void | false): this; /** * Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event. * @param handler The function to be invoked. * @see \`{@link https://api.jquery.com/ajaxSuccess/ }\` * @since 1.0 * @example ​ ````Show a message when an Ajax request completes successfully. ```javascript $( document ).ajaxSuccess(function( event, request, settings ) { $( "#msg" ).append( "
  • Successful Request!
  • " ); }); ``` */ ajaxSuccess(handler: (this: Document, event: JQuery.TriggeredEvent, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings, data: JQuery.PlainObject) => void | false): this; /** * Perform a custom animation of a set of CSS properties. * @param properties An object of CSS properties and values that the animation will move toward. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 * @example ​ ````An example of using an 'easing' function to provide a different style of animation. This will only work if you have a plugin that provides this easing function. Note, this code will do nothing unless the paragraph element is hidden. ```javascript $( "p" ).animate({ opacity: "show" }, "slow", "easein" ); ``` * @example ​ ````Animate all paragraphs and execute a callback function when the animation is complete. The first argument is an object of CSS properties, the second specifies that the animation should take 1000 milliseconds to complete, the third states the easing type, and the fourth argument is an anonymous callback function. ```javascript $( "p" ).animate({ height: 200, width: 400, opacity: 0.5 }, 1000, "linear", function() { alert( "all done" ); }); ``` */ animate(properties: JQuery.PlainObject, duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Perform a custom animation of a set of CSS properties. * @param properties An object of CSS properties and values that the animation will move toward. * @param duration_easing _@param_ `duration_easing` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 * @example ​ ````Click the button to animate the div with a number of different properties. ```html animate demo
    Hello!
    ​ ``` * @example ​ ````Animates a div's left property with a relative value. Click several times on the buttons to see the relative animations queued up. ```html animate demo
    ​ ``` * @example ​ ````Animate all paragraphs to toggle both height and opacity, completing the animation within 600 milliseconds. ```javascript $( "p" ).animate({ height: "toggle", opacity: "toggle" }, "slow" ); ``` * @example ​ ````Animate all paragraphs to a left style of 50 and opacity of 1 (opaque, visible), completing the animation within 500 milliseconds. ```javascript $( "p" ).animate({ left: 50, opacity: 1 }, 500 ); ``` */ animate(properties: JQuery.PlainObject, duration_easing: JQuery.Duration | string, complete?: (this: TElement) => void): this; /** * Perform a custom animation of a set of CSS properties. * @param properties An object of CSS properties and values that the animation will move toward. * @param options A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 * @example ​ ````The first button shows how an unqueued animation works. It expands the div out to 90% width while the font-size is increasing. Once the font-size change is complete, the border animation will begin. The second button starts a traditional chained animation, where each animation will start once the previous animation on the element has completed. ```html animate demo
    Block1
    Block2
    ​ ``` * @example ​ ````Animates the first div's left property and synchronizes the remaining divs, using the step function to set their left properties at each stage of the animation. ```html animate demo

    ​ ``` * @example ​ ````Animate the left and opacity style properties of all paragraphs; run the animation outside the queue, so that it will automatically start without waiting for its turn. ```javascript $( "p" ).animate({ left: "50px", opacity: 1 }, { duration: 500, queue: false }); ``` * @example ​ ````Animates all paragraphs to toggle both height and opacity, completing the animation within 600 milliseconds. ```javascript $( "p" ).animate({ height: "toggle", opacity: "toggle" }, { duration: "slow" }); ``` * @example ​ ````Use an easing function to provide a different style of animation. This will only work if you have a plugin that provides this easing function. ```javascript $( "p" ).animate({ opacity: "show" }, { duration: "slow", easing: "easein" }); ``` */ animate(properties: JQuery.PlainObject, options: JQuery.EffectsOptions): this; /** * Perform a custom animation of a set of CSS properties. * @param properties An object of CSS properties and values that the animation will move toward. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 */ animate(properties: JQuery.PlainObject, complete?: (this: TElement) => void): this; /** * Insert content, specified by the parameter, to the end of each element in the set of matched elements. * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert at the end of each element in the set of matched elements. * @see \`{@link https://api.jquery.com/append/ }\` * @since 1.0 * @example ​ ````Appends some HTML to all paragraphs. ```html append demo

    I would like to say:

    ​ ``` * @example ​ ````Appends an Element to all paragraphs. ```html append demo

    I would like to say:

    ​ ``` * @example ​ ````Appends a jQuery object (similar to an Array of DOM Elements) to all paragraphs. ```html append demo Hello world!!!

    I would like to say:

    ​ ``` */ append(...contents: Array>>): this; /** * Insert content, specified by the parameter, to the end of each element in the set of matched elements. * @param funсtion A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert at * the end of each element in the set of matched elements. Receives the index position of the element * in the set and the old HTML value of the element as arguments. Within the function, `this` refers to * the current element in the set. * @see \`{@link https://api.jquery.com/append/ }\` * @since 1.4 */ append(funсtion: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; /** * Insert every element in the set of matched elements to the end of the target. * @param target A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements * will be inserted at the end of the element(s) specified by this parameter. * @see \`{@link https://api.jquery.com/appendTo/ }\` * @since 1.0 * @example ​ ````Append all spans to the element with the ID "foo" (Check append() documentation for more examples) ```html appendTo demo I have nothing more to say...
    FOO!
    ​ ``` */ appendTo(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; /** * Set one or more attributes for the set of matched elements. * @param attributeName The name of the attribute to set. * @param value_function _@param_ `value_function` *
    * * `value` — A value to set for the attribute. If `null`, the specified attribute will be removed (as in \`{@link removeAttr .removeAttr()}`).
    * * `function` — A function returning the value to set. `this` is the current element. Receives the index position of * the element in the set and the old attribute value as arguments. * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 * @since 1.1 * @example ​ ````Set the id for divs based on the position in the page. ```html attr demo
    Zero-th
    First
    Second
    ​ ``` * @example ​ ````Set the src attribute from title attribute on the image. ```html attr demo ​ ``` */ attr(attributeName: string, value_function: string | number | null | ((this: TElement, index: number, attr: string) => string | number | void | undefined)): this; /** * Set one or more attributes for the set of matched elements. * @param attributes An object of attribute-value pairs to set. * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 * @example ​ ````Set some attributes for all <img>s in the page. ```html attr demo
    Attribute of Ajax
    ​ ``` */ attr(attributes: JQuery.PlainObject): this; /** * Get the value of an attribute for the first element in the set of matched elements. * @param attributeName The name of the attribute to get. * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 * @example ​ ````Display the checked attribute and property of a checkbox as it changes. ```html attr demo

    ​ ``` * @example ​ ````Find the title attribute of the first <em> in the page. ```html attr demo

    Once there was a large dinosaur...

    ​ The title of the emphasis is:
    ​ ``` */ attr(attributeName: string): string | undefined; /** * Insert content, specified by the parameter, before each element in the set of matched elements. * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert before each element in the set of matched elements. * @see \`{@link https://api.jquery.com/before/ }\` * @since 1.0 * @example ​ ````Inserts some HTML before all paragraphs. ```html before demo

    is what I said...

    ​ ``` * @example ​ ````Inserts a DOM element before all paragraphs. ```html before demo

    is what I said...

    ​ ``` * @example ​ ````Inserts a jQuery object (similar to an Array of DOM Elements) before all paragraphs. ```html before demo

    is what I said...

    Hello ​ ``` */ before(...contents: Array>>): this; /** * Insert content, specified by the parameter, before each element in the set of matched elements. * @param function_functionーhtml _@param_ `function_functionーhtml` *
    * * `function` — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert * before each element in the set of matched elements. Receives the index position of the element in * the set as an argument. Within the function, `this` refers to the current element in the set.
    * * `functionーhtml` — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert * before each element in the set of matched elements. Receives the index position of the element in * the set and the old HTML value of the element as arguments. Within the function, `this` refers to the * current element in the set. * @see \`{@link https://api.jquery.com/before/ }\` * @since 1.4 * @since 1.10 */ before(function_functionーhtml: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; // [bind() overloads] https://github.com/jquery/api.jquery.com/issues/1048 /** * Attach a handler to an event for the elements. * @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. */ bind( eventType: TType, eventData: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach a handler to an event for the elements. * @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * @param handler_preventBubble _@param_ `handler_preventBubble` *
    * * `handler` — A function to execute each time the event is triggered.
    * * `preventBubble` — Setting the third argument to false will attach a function that prevents the default action from * occurring and stops the event from bubbling. The default is `true`. * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````Handle click and double-click for the paragraph. Note: the coordinates are window relative, so in this case relative to the demo iframe. ```html bind demo

    Click or double click here.

    ​ ``` * @example ​ ````To display each paragraph's text in an alert box whenever it is clicked: ```javascript $( "p" ).bind( "click", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Cancel a default action and prevent it from bubbling up by returning false: ```javascript $( "form" ).bind( "submit", function() { return false; }) ``` * @example ​ ````Cancel only the default action by using the .preventDefault() method. ```javascript $( "form" ).bind( "submit", function( event ) { event.preventDefault(); }); ``` * @example ​ ````Stop an event from bubbling without preventing the default action by using the .stopPropagation() method. ```javascript $( "form" ).bind( "submit", function( event ) { event.stopPropagation(); }); ``` * @example ​ ````Bind custom events. ```html bind demo

    Has an attached custom event.

    ​ ``` */ bind( eventType: TType, handler_preventBubble: JQuery.TypeEventHandler | false | null | undefined ): this; /** * Attach a handler to an event for the elements. * @param events An object containing one or more DOM event types and functions to execute for them. * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.4 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````Bind multiple events simultaneously. ```javascript $( "div.test" ).bind({ click: function() { $( this ).addClass( "active" ); }, mouseenter: function() { $( this ).addClass( "inside" ); }, mouseleave: function() { $( this ).removeClass( "inside" ); } }); ``` */ bind(events: JQuery.TypeEventHandlers): this; /** * Bind an event handler to the "blur" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/blur/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ blur(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "blur" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/blur/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To trigger the blur event on all paragraphs: ```javascript $( "p" ).blur(); ``` */ blur(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "change" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/change/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ change(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "change" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/change/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Attaches a change event to the select that gets the text for each selected option and writes them in the div. It then triggers the event for the initial text draw. ```html change demo
    ​ ``` * @example ​ ````To add a validity test to all text input elements: ```javascript $( "input[type='text']" ).change(function() { // Check input( $( this ).val() ) for validity here }); ``` */ change(handler?: JQuery.TypeEventHandler | false): this; /** * Get the children of each element in the set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/children/ }\` * @since 1.0 * @example ​ ````Find all children of the clicked element. ```html children demo

    This is the way we write the demo,

    write the demo, demo,
    This the way we write the demo so in

    the morning. Found 0 children in TAG.

    ​ ``` * @example ​ ````Find all children of each div. ```html children demo

    Hello (this is a paragraph)

    Hello Again (this span is a child of the a div)

    And Again (in another paragraph)

    And One Last Time (most text directly in a div)
    ​ ``` * @example ​ ````Find all children with a class "selected" of each div. ```html children demo
    Hello

    Hello Again

    And Again

    And One Last Time

    ​ ``` */ children(selector?: JQuery.Selector): this; /** * Remove from the queue all items that have not yet been run. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @see \`{@link https://api.jquery.com/clearQueue/ }\` * @since 1.4 * @example ​ ````Empty the queue. ```html clearQueue demo
    ​ ``` */ clearQueue(queueName?: string): this; /** * Bind an event handler to the "click" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/click/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ click(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "click" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/click/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Hide paragraphs on a page when they are clicked: ```html click demo

    First Paragraph

    Second Paragraph

    Yet one more Paragraph

    ​ ``` * @example ​ ````Trigger the click event on all of the paragraphs on the page: ```javascript $( "p" ).click(); ``` */ click(handler?: JQuery.TypeEventHandler | false): this; /** * Create a deep copy of the set of matched elements. * @param withDataAndEvents A Boolean indicating whether event handlers and data should be copied along with the elements. The * default value is false. *In jQuery 1.5.0 the default value was incorrectly true; it was changed back * to false in 1.5.1 and up. * @param deepWithDataAndEvents A Boolean indicating whether event handlers and data for all children of the cloned element should * be copied. By default its value matches the first argument's value (which defaults to false). * @see \`{@link https://api.jquery.com/clone/ }\` * @since 1.0 * @since 1.5 * @example ​ ````Clones all b elements (and selects the clones) and prepends them to all paragraphs. ```html clone demo Hello

    , how are you?

    ​ ``` */ clone(withDataAndEvents?: boolean, deepWithDataAndEvents?: boolean): this; /** * For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree. * @param selector A string containing a selector expression to match elements against. * @param context A DOM element within which a matching element may be found. * @see \`{@link https://api.jquery.com/closest/ }\` * @since 1.4 */ closest(selector: JQuery.Selector, context: Element): this; /** * For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree. * @param selector_selection_element _@param_ `selector_selection_element` *
    * * `selector` — A string containing a selector expression to match elements against.
    * * `selection` — A jQuery object to match elements against.
    * * `element` — An element to match elements against. * @see \`{@link https://api.jquery.com/closest/ }\` * @since 1.3 * @since 1.6 * @example ​ ````Show how event delegation can be done with closest. The closest list element toggles a yellow background when it or its descendent is clicked. ```html closest demo
    • Click me!
    • You can also Click me!
    ​ ``` * @example ​ ````Pass a jQuery object to closest. The closest list element toggles a yellow background when it or its descendent is clicked. ```html closest demo
    • Click me!
    • You can also Click me!
    ​ ``` */ closest(selector_selection_element: JQuery.Selector | Element | JQuery): this; /** * Get the children of each element in the set of matched elements, including text and comment nodes. * @see \`{@link https://api.jquery.com/contents/ }\` * @since 1.2 * @example ​ ````Find all the text nodes inside a paragraph and wrap them with a bold tag. ```html contents demo

    Hello John, how are you doing?

    ​ ``` * @example ​ ````Change the background color of links inside of an iframe. ```html contents demo ​ ``` */ contents(): JQuery; /** * Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/contextmenu/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ contextmenu(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/contextmenu/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To show a "Hello World!" alert box when the contextmenu event is triggered on a paragraph on the page: ```javascript $( "p" ).contextmenu(function() { alert( "Hello World!" ); }); ``` * @example ​ ````Right click to toggle background color. ```html contextmenu demo
    Right click the block ​ ``` */ contextmenu(handler?: JQuery.TypeEventHandler | false): this; /** * Set one or more CSS properties for the set of matched elements. * @param propertyName A CSS property name. * @param value_function _@param_ `value_function` *
    * * `value` — A value to set for the property.
    * * `function` — A function returning the value to set. `this` is the current element. Receives the index position of * the element in the set and the old value as arguments. * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Change the color of any paragraph to red on mouseover event. ```html css demo

    Just roll the mouse over me.

    Or me to see a color change.

    ​ ``` * @example ​ ````Increase the width of #box by 200 pixels the first time it is clicked. ```html css demo
    Click me to grow
    ​ ``` * @example ​ ````Highlight a clicked word in the paragraph. ```html css demo

    Once upon a time there was a man who lived in a pizza parlor. This man just loved pizza and ate it all the time. He went on to be the happiest man in the world. The end.

    ​ ``` */ css(propertyName: string, value_function: string | number | ((this: TElement, index: number, value: string) => string | number | void | undefined)): this; /** * Set one or more CSS properties for the set of matched elements. * @param properties An object of property-value pairs to set. * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 * @example ​ ````Change the font weight and background color on mouseenter and mouseleave. ```html css demo

    Move the mouse over a paragraph.

    Like this one or the one above.

    ​ ``` * @example ​ ````Increase the size of a div when you click it. ```html css demo
    click
    click
    ​ ``` */ css(properties: JQuery.PlainObject string | number | void | undefined)>): this; /** * Get the computed style properties for the first element in the set of matched elements. * @param propertyName A CSS property. * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 * @example ​ ````Get the background color of a clicked div. ```html css demo  
    ​ ``` */ css(propertyName: string): string; /** * Get the computed style properties for the first element in the set of matched elements. * @param propertyNames An array of one or more CSS properties. * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.9 * @example ​ ````Get the width, height, text color, and background color of a clicked div. ```html css demo

     

    1
    2
    3
    4
    ​ ``` */ css(propertyNames: string[]): JQuery.PlainObject; /** * Store arbitrary data associated with the matched elements. * @param key A string naming the piece of data to set. * @param value The new data value; this can be any Javascript type except `undefined`. * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 * @example ​ ````Store then retrieve a value from the div element. ```html data demo
    The values stored were and
    ​ ``` */ data(key: string, value: string | number | boolean | symbol | object | null): this; /** * Store arbitrary data associated with the matched elements. * @param obj An object of key-value pairs of data to update. * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.4.3 */ data(obj: JQuery.PlainObject): this; /** * Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute. * @param key Name of the data stored. * @param value `undefined` is not recognized as a data value. Calls such as `.data( "name", undefined )` * will return the jQuery object that it was called on, allowing for chaining. * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 */ // `unified-signatures` is disabled so that behavior when passing `undefined` to `value` can be documented. Unifying the signatures // results in potential confusion for users from an unexpected parameter. // tslint:disable-next-line:unified-signatures data(key: string, value: undefined): any; /** * Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute. * @param key Name of the data stored. * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 * @example ​ ````Get the data named "blah" stored at for an element. ```html data demo
    A div

    The "blah" value of this div is ?

    ​ ``` */ data(key: string): any; /** * Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute. * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.4 */ data(): JQuery.PlainObject; /** * Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/dblclick/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ dblclick(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/dblclick/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To bind a "Hello World!" alert box to the dblclick event on every paragraph on the page: ```javascript $( "p" ).dblclick(function() { alert( "Hello World!" ); }); ``` * @example ​ ````Double click to toggle background color. ```html dblclick demo
    Double click the block ​ ``` */ dblclick(handler?: JQuery.TypeEventHandler | false): this; /** * Set a timer to delay execution of subsequent items in the queue. * @param duration An integer indicating the number of milliseconds to delay execution of the next item in the queue. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @see \`{@link https://api.jquery.com/delay/ }\` * @since 1.4 * @example ​ ````Animate the hiding and showing of two divs, delaying the first before showing it. ```html delay demo

    ​ ``` */ delay(duration: JQuery.Duration, queueName?: string): this; /** * Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements. * @param selector A selector to filter the elements that trigger the event. * @param eventType A string containing one or more space-separated JavaScript event types, such as "click" or * "keydown," or custom event names. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.2 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. */ delegate( selector: JQuery.Selector, eventType: TType, eventData: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements. * @param selector A selector to filter the elements that trigger the event. * @param eventType A string containing one or more space-separated JavaScript event types, such as "click" or * "keydown," or custom event names. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.2 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````Click a paragraph to add another. Note that .delegate() attaches a click event handler to all paragraphs - even new ones. ```html delegate demo

    Click me!

    ​ ``` * @example ​ ````To display each paragraph's text in an alert box whenever it is clicked: ```javascript $( "body" ).delegate( "p", "click", function() { alert( $( this ).text() ); }); ``` * @example ​ ````To cancel a default action and prevent it from bubbling up, return false: ```javascript $( "body" ).delegate( "a", "click", function() { return false; }); ``` * @example ​ ````To cancel only the default action by using the preventDefault method. ```javascript $( "body" ).delegate( "a", "click", function( event ) { event.preventDefault(); }); ``` * @example ​ ````Can bind custom events too. ```html delegate demo

    Has an attached custom event.

    ​ ``` */ delegate( selector: JQuery.Selector, eventType: TType, handler: JQuery.TypeEventHandler | false ): this; /** * Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements. * @param selector A selector to filter the elements that trigger the event. * @param events A plain object of one or more event types and functions to execute for them. * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. Use \`{@link on }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. */ delegate(selector: JQuery.Selector, events: JQuery.TypeEventHandlers ): this; /** * Execute the next function on the queue for the matched elements. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @see \`{@link https://api.jquery.com/dequeue/ }\` * @since 1.2 * @example ​ ````Use dequeue to end a custom queue function which allows the queue to keep going. ```html dequeue demo
    ​ ``` */ dequeue(queueName?: string): this; /** * Remove the set of matched elements from the DOM. * @param selector A selector expression that filters the set of matched elements to be removed. * @see \`{@link https://api.jquery.com/detach/ }\` * @since 1.4 * @example ​ ````Detach all paragraphs from the DOM ```html detach demo

    Hello

    how are

    you?

    ​ ``` */ detach(selector?: JQuery.Selector): this; /** * Iterate over a jQuery object, executing a function for each matched element. * @param funсtion A function to execute for each matched element. * @see \`{@link https://api.jquery.com/each/ }\` * @since 1.0 * @example ​ ````Iterate over three divs and sets their color property. ```html each demo
    Click here
    to iterate through
    these divs.
    ​ ``` * @example ​ ````To access a jQuery object instead of the regular DOM element, use $( this ). For example: ```html each demo ​ To do list: (click here to change)
    • Eat
    • Sleep
    • Be merry
    ​ ``` * @example ​ ````Use return false to break out of each() loops early. ```html each demo
    Stop here
    ​ ``` */ each(funсtion: (this: TElement, index: number, element: TElement) => void | false): this; /** * Remove all child nodes of the set of matched elements from the DOM. * @see \`{@link https://api.jquery.com/empty/ }\` * @since 1.0 * @example ​ ````Removes all child nodes (including text nodes) from all paragraphs ```html empty demo

    Hello, Person and person.

    ​ ``` */ empty(): this; /** * End the most recent filtering operation in the current chain and return the set of matched elements to its previous state. * @see \`{@link https://api.jquery.com/end/ }\` * @since 1.0 * @example ​ ````Selects all paragraphs, finds span elements inside these, and reverts the selection back to the paragraphs. ```html end demo

    Hi there how are you doing?

    This span is one of several spans in this sentence.

    Tags in jQuery object initially:
    Tags in jQuery object after find:
    Tags in jQuery object after end:
    ​ ``` * @example ​ ````Selects all paragraphs, finds span elements inside these, and reverts the selection back to the paragraphs. ```html end demo

    Hello, how are you?

    ​ ``` */ end(): this; /** * Reduce the set of matched elements to the one at the specified index. * @param index An integer indicating the 0-based position of the element. * An integer indicating the position of the element, counting backwards from the last element in the set. * @see \`{@link https://api.jquery.com/eq/ }\` * @since 1.1.2 * @since 1.4 * @example ​ ````Turn the div with index 2 blue by adding an appropriate class. ```html eq demo
    ​ ``` */ eq(index: number): this; /** * Merge the contents of an object onto the jQuery prototype to provide new jQuery instance methods. * @param obj An object to merge onto the jQuery prototype. * @see \`{@link https://api.jquery.com/jQuery.fn.extend/ }\` * @since 1.0 * @example ​ ````Add two methods to the jQuery prototype ($.fn) object and then use one of them. ```html jQuery.fn.extend demo ​ ``` */ extend(obj: object): this; /** * Display the matched elements by fading them to opaque. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.4.3 */ fadeIn(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Display the matched elements by fading them to opaque. * @param duration_easing _@param_ `duration_easing` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Fades a red block in over the text. Once the animation is done, it quickly fades in more text on top. ```html fadeIn demo

    Let it be known that the party of the first part and the party of the second part are henceforth and hereto directed to assess the allegations for factual correctness... (click!)

    CENSORED!

    ​ ``` */ fadeIn(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Display the matched elements by fading them to opaque. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition.
    * * `complete` — A function to call once the animation is complete, called once per matched element.
    * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates hidden divs to fade in one by one, completing each animation within 600 milliseconds. ```html fadeIn demo Click here...
    ​ ``` */ fadeIn(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Hide the matched elements by fading them to transparent. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.4.3 * @example ​ ````Fades out two divs, one with a "linear" easing and one with the default, "swing," easing. ```html fadeOut demo
    linear
    swing
    ​ ``` */ fadeOut(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Hide the matched elements by fading them to transparent. * @param duration_easing _@param_ `duration_easing` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Fades out spans in one section that you click on. ```html fadeOut demo

    Find the modifiers -

    If you really want to go outside in the cold then make sure to wear your warm jacket given to you by your favorite teacher.

    ​ ``` */ fadeOut(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Hide the matched elements by fading them to transparent. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition.
    * * `complete` — A function to call once the animation is complete, called once per matched element.
    * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all paragraphs to fade out, completing the animation within 600 milliseconds. ```html fadeOut demo

    If you click on this paragraph you'll see it just fade away.

    ​ ``` */ fadeOut(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Adjust the opacity of the matched elements. * @param duration A string or number determining how long the animation will run. * @param opacity A number between 0 and 1 denoting the target opacity. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeTo/ }\` * @since 1.4.3 */ fadeTo(duration: JQuery.Duration, opacity: number, easing: string, complete?: (this: TElement) => void): this; /** * Adjust the opacity of the matched elements. * @param duration A string or number determining how long the animation will run. * @param opacity A number between 0 and 1 denoting the target opacity. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeTo/ }\` * @since 1.0 * @example ​ ````Animates first paragraph to fade to an opacity of 0.33 (33%, about one third visible), completing the animation within 600 milliseconds. ```html fadeTo demo

    Click this paragraph to see it fade.

    Compare to this one that won't fade.

    ​ ``` * @example ​ ````Fade div to a random opacity on each click, completing the animation within 200 milliseconds. ```html fadeTo demo

    And this is the library that John built...

    ​ ``` * @example ​ ````Find the right answer! The fade will take 250 milliseconds and change various styles when it completes. ```html fadeTo demo

    Wrong

    Wrong

    Right!

    ​ ``` */ fadeTo(duration: JQuery.Duration, opacity: number, complete?: (this: TElement) => void): this; /** * Display or hide the matched elements by animating their opacity. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.4.4 * @example ​ ````Fades first paragraph in or out, completing the animation within 600 milliseconds and using a linear easing. Fades last paragraph in or out for 200 milliseconds, inserting a "finished" message upon completion. ```html fadeToggle demo

    This paragraph has a slow, linear fade.

    This paragraph has a fast animation.

    ​ ``` */ fadeToggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Display or hide the matched elements by animating their opacity. * @param duration_easing _@param_ `duration_easing` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Fades first paragraph in or out, completing the animation within 600 milliseconds and using a linear easing. Fades last paragraph in or out for 200 milliseconds, inserting a "finished" message upon completion. ```html fadeToggle demo

    This paragraph has a slow, linear fade.

    This paragraph has a fast animation.

    ​ ``` */ fadeToggle(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Display or hide the matched elements by animating their opacity. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `easing` — A string indicating which easing function to use for the transition.
    * * `complete` — A function to call once the animation is complete, called once per matched element.
    * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.0 * @since 1.4.3 */ fadeToggle(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Reduce the set of matched elements to those that match the selector or pass the function's test. * @param selector_elements_selection_function _@param_ `selector_elements_selection_function` *
    * * `selector` — A string containing a selector expression to match the current set of elements against.
    * * `elements` — One or more DOM elements to match the current set of elements against.
    * * `selection` — An existing jQuery object to match the current set of elements against.
    * * `function` — A function used as a test for each element in the set. this is the current DOM element. * @see \`{@link https://api.jquery.com/filter/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Change the color of all divs; then add a border to those with a "middle" class. ```html filter demo
    ​ ``` * @example ​ ````Change the color of all divs; then add a border to the second one (index == 1) and the div with an id of "fourth." ```html filter demo
    ​ ``` * @example ​ ````Select all divs and filter the selection with a DOM element, keeping only the one with an id of "unique". ```javascript $( "div" ).filter( document.getElementById( "unique" ) ); ``` * @example ​ ````Select all divs and filter the selection with a jQuery object, keeping only the one with an id of "unique". ```javascript $( "div" ).filter( $( "#unique" ) ); ``` */ filter(selector_elements_selection_function: JQuery.Selector | JQuery.TypeOrArray | JQuery | ((this: TElement, index: number, element: TElement) => boolean) ): this; /** * Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element. * @param selector_element _@param_ `selector_element` *
    * * `selector` — A string containing a selector expression to match elements against.
    * * `element` — An element or a jQuery object to match elements against. * @see \`{@link https://api.jquery.com/find/ }\` * @since 1.0 * @since 1.6 * @example ​ ````Starts with all paragraphs and searches for descendant span elements, same as $( "p span" ) ```html find demo

    Hello, how are you?

    Me? I'm good.

    ​ ``` * @example ​ ````A selection using a jQuery collection of all span tags. Only spans within p tags are changed to red while others are left blue. ```html find demo

    Hello, how are you?

    Me? I'm good.

    Did you eat yet?
    ​ ``` * @example ​ ````Add spans around each word then add a hover and italicize words with the letter t. ```html find demo

    When the day is short find that which matters to you or stop believing

    ​ ``` */ find(selector_element: K | JQuery): JQuery; find(selector_element: K | JQuery): JQuery; find(selector_element: JQuery.Selector | Element | E | JQuery): JQuery; /** * Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements. * @param queue The name of the queue in which to stop animations. * @see \`{@link https://api.jquery.com/finish/ }\` * @since 1.9 * @example ​ ````Click the Go button once to start the animation, and then click the other buttons to see how they affect the current and queued animations. ```html finish demo





    ​ ``` */ finish(queue?: string): this; /** * Reduce the set of matched elements to the first in the set. * @see \`{@link https://api.jquery.com/first/ }\` * @since 1.4 * @example ​ ````Highlight the first span in a paragraph. ```html first demo

    Look: This is some text in a paragraph. This is a note about it.

    ​ ``` */ first(): this; /** * Bind an event handler to the "focus" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focus/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ focus(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "focus" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focus/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Fire focus. ```html focus demo

    focus fire

    focus fire

    ​ ``` * @example ​ ````To stop people from writing in text input boxes, try: ```javascript $( "input[type=text]" ).focus(function() { $( this ).blur(); }); ``` * @example ​ ````To focus on a login input box with id 'login' on page startup, try: ```javascript $( document ).ready(function() { $( "#login" ).focus(); }); ``` */ focus(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "focusin" event. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focusin/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ focusin(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "focusin" event. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focusin/ }\` * @since 1.4 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Watch for a focus to occur within the paragraphs on the page. ```html focusin demo

    focusin fire

    focusin fire

    ​ ``` */ focusin(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "focusout" JavaScript event. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focusout/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ focusout(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "focusout" JavaScript event. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/focusout/ }\` * @since 1.4 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Watch for a loss of focus to occur inside paragraphs and note the difference between the focusout count and the blur count. (The blur count does not change because those events do not bubble.) ```html focusout demo


    focusout fire
    blur fire
    ​ ``` */ focusout(handler?: JQuery.TypeEventHandler | false): this; /** * Retrieve one of the elements matched by the jQuery object. * @param index A zero-based integer indicating which element to retrieve. * @see \`{@link https://api.jquery.com/get/ }\` * @since 1.0 * @example ​ ````Display the tag name of the click element. ```html get demo  

    In this paragraph is an important section

    ​ ``` */ get(index: number): TElement; /** * Retrieve the elements matched by the jQuery object. * @see \`{@link https://api.jquery.com/get/ }\` * @since 1.0 * @example ​ ````Select all divs in the document and return the DOM Elements as an Array; then use the built-in reverse() method to reverse that array. ```html get demo ​ Reversed -
    One
    Two
    Three
    ​ ``` */ get(): TElement[]; /** * Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element. * @param selector_contained _@param_ `selector_contained` *
    * * `selector` — A string containing a selector expression to match elements against.
    * * `contained` — A DOM element to match elements against. * @see \`{@link https://api.jquery.com/has/ }\` * @since 1.4 * @example ​ ````Check if an element is inside another. ```html has demo
    • Does the UL contain an LI?
    ​ ``` */ has(selector_contained: string | Element): this; /** * Determine whether any of the matched elements are assigned the given class. * @param className The class name to search for. * @see \`{@link https://api.jquery.com/hasClass/ }\` * @since 1.2 * @example ​ ````Looks for the paragraph that contains 'selected' as a class. ```html hasClass demo

    This paragraph is black and is the first paragraph.

    This paragraph is red and is the second paragraph.

    First paragraph has selected class:
    Second paragraph has selected class:
    At least one paragraph has selected class:
    ​ ``` */ hasClass(className: string): boolean; /** * Set the CSS height of every matched element. * @param value_function _@param_ `value_function` *
    * * `value` — An integer representing the number of pixels, or an integer with an optional unit of measure * appended (as a string).
    * * `function` — A function returning the height to set. Receives the index position of the element in the set and * the old height as arguments. Within the function, `this` refers to the current element in the set. * @see \`{@link https://api.jquery.com/height/ }\` * @since 1.0 * @since 1.4.1 * @example ​ ````To set the height of each div on click to 30px plus a color change. ```html height demo
    ​ ``` */ height(value_function: string | number | ((this: TElement, index: number, height: number) => string | number)): this; /** * Get the current computed height for the first element in the set of matched elements. * @see \`{@link https://api.jquery.com/height/ }\` * @since 1.0 * @example ​ ````Show various heights. Note the values are from the iframe so might be smaller than you expected. The yellow highlight shows the iframe body. ```html height demo
     

    Sample paragraph to test height

    ​ ``` */ height(): number | undefined; /** * Hide the matched elements. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.4.3 */ hide(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): this; /** * Hide the matched elements. * @param duration A string or number determining how long the animation will run. * @param easing_complete _@param_ `easing_complete` *
    * * `easing` — A string indicating which easing function to use for the transition.
    * * `complete` — A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all spans (words in this case) to hide fastly, completing each animation within 200 milliseconds. Once each animation is done, it starts the next one. ```html hide demo
    Once upon a time there were three programmers...
    ​ ``` * @example ​ ````Hides the divs when clicked over 2 seconds, then removes the div element when its hidden. Try clicking on more than one box at a time. ```html hide demo
    ​ ``` */ hide(duration: JQuery.Duration, easing_complete: string | ((this: TElement) => void)): this; /** * Hide the matched elements. * @param duration_complete_options _@param_ `duration_complete_options` *
    * * `duration` — A string or number determining how long the animation will run.
    * * `complete` — A function to call once the animation is complete, called once per matched element.
    * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.0 * @example ​ ````Hides all paragraphs then the link on click. ```html hide demo

    Hello

    Click to hide me too

    Here is another paragraph

    ​ ``` * @example ​ ````Animates all shown paragraphs to hide slowly, completing the animation within 600 milliseconds. ```html hide demo

    Hiya

    Such interesting text, eh?

    ​ ``` */ hide(duration_complete_options?: JQuery.Duration | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements. * @param handlerIn A function to execute when the mouse pointer enters the element. * @param handlerOut A function to execute when the mouse pointer leaves the element. * @see \`{@link https://api.jquery.com/hover/ }\` * @since 1.0 * @deprecated ​ Deprecated. * * **Cause**: The `.hover()` method is a shorthand for the use of the `mouseover`/`mouseout` events. It is often a poor user interface choice because it does not allow for any small amounts of delay between when the mouse enters or exits an area and when the event fires. This can make it quite difficult to use with UI widgets such as drop-down menus. For more information on the problems of hovering, see the \`{@link http://cherne.net/brian/resources/jquery.hoverIntent.html hoverIntent plugin}\`. * * **Solution**: Review uses of `.hover()` to determine if they are appropriate, and consider use of plugins such as `hoverIntent` as an alternative. The direct replacement for `.hover(fn1, fn2)`, is `.on("mouseenter", fn1).on("mouseleave", fn2)`. * @example ​ ````To add a special style to list items that are being hovered over, try: ```html hover demo
    • Milk
    • Bread
    • Chips
    • Socks
    ​ ``` * @example ​ ````To add a special style to table cells that are being hovered over, try: ```javascript $( "td" ).hover( function() { $( this ).addClass( "hover" ); }, function() { $( this ).removeClass( "hover" ); } ); ``` * @example ​ ````To unbind the above example use: ```javascript $( "td" ).off( "mouseenter mouseleave" ); ``` */ hover(handlerIn: JQuery.TypeEventHandler | false, handlerOut: JQuery.TypeEventHandler | false): this; /** * Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements. * @param handlerInOut A function to execute when the mouse pointer enters or leaves the element. * @see \`{@link https://api.jquery.com/hover/ }\` * @since 1.4 * @deprecated ​ Deprecated. * * **Cause**: The `.hover()` method is a shorthand for the use of the `mouseover`/`mouseout` events. It is often a poor user interface choice because it does not allow for any small amounts of delay between when the mouse enters or exits an area and when the event fires. This can make it quite difficult to use with UI widgets such as drop-down menus. For more information on the problems of hovering, see the \`{@link http://cherne.net/brian/resources/jquery.hoverIntent.html hoverIntent plugin}\`. * * **Solution**: Review uses of `.hover()` to determine if they are appropriate, and consider use of plugins such as `hoverIntent` as an alternative. The direct replacement for `.hover(fn1, fn2)`, is `.on("mouseenter", fn1).on("mouseleave", fn2)`. * @example ​ ````Slide the next sibling LI up or down on hover, and toggle a class. ```html hover demo
    • Milk
    • White
    • Carrots
    • Orange
    • Broccoli
    • Green
    ​ ``` */ hover(handlerInOut: JQuery.TypeEventHandler | false): this; /** * Set the HTML contents of each element in the set of matched elements. * @param htmlString_function _@param_ `htmlString_function` *
    * * `htmlString` — A string of HTML to set as the content of each matched element.
    * * `function` — A function returning the HTML content to set. Receives the index position of the element in the set * and the old HTML value as arguments. jQuery empties the element before calling the function; use the * oldhtml argument to reference the previous content. Within the function, `this` refers to the current * element in the set. * @see \`{@link https://api.jquery.com/html/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Add some html to each div. ```html html demo Hello
    ​ ``` * @example ​ ````Add some html to each div then immediately do further manipulations to the inserted html. ```html html demo
    ​ ``` */ html(htmlString_function: JQuery.htmlString | JQuery.Node | ((this: TElement, index: number, oldhtml: JQuery.htmlString) => JQuery.htmlString | JQuery.Node)): this; /** * Get the HTML contents of the first element in the set of matched elements. * @see \`{@link https://api.jquery.com/html/ }\` * @since 1.0 * @example ​ ````Click a paragraph to convert it from html to text. ```html html demo

    Click to change the html

    to a text node.

    This does nothing.

    ​ ``` */ html(): string; /** * Search for a given element from among the matched elements. * @param selector_element _@param_ `selector_element` *
    * * `selector` — A selector representing a jQuery collection in which to look for an element.
    * * `element` — The DOM element or first element within the jQuery object to look for. * @see \`{@link https://api.jquery.com/index/ }\` * @since 1.0 * @since 1.4 * @example ​ ````On click, returns the index (zero-based) of that div in the page. ```html index demo Click a div!
    First div
    Second div
    Third div
    ​ ``` * @example ​ ````Returns the index for the element with ID bar. ```html index demo
    • foo
    • bar
    • baz
    ​ ``` * @example ​ ````Returns the index for the first item in the jQuery collection. ```html index demo
    • foo
    • bar
    • baz
    ​ ``` * @example ​ ````Returns the index for the element with ID bar in relation to all <li> elements. ```html index demo
    • foo
    • bar
    • baz
    ​ ``` * @example ​ ````Returns the index for the element with ID bar in relation to its siblings. ```html index demo
    • foo
    • bar
    • baz
    ​ ``` * @example ​ ````Returns -1, as there is no element with ID foobar. ```html index demo
    • foo
    • bar
    • baz
    ​ ``` */ index(selector_element?: JQuery.Selector | Element | JQuery): number; /** * Set the CSS inner height of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
    * * `value` — A number representing the number of pixels, or a number along with an optional unit of measure * appended (as a string).
    * * `function` — A function returning the inner height (including padding but not border) to set. Receives the index * position of the element in the set and the old inner height as arguments. Within the function, `this` * refers to the current element in the set. * @see \`{@link https://api.jquery.com/innerHeight/ }\` * @since 1.8.0 * @example ​ ````Change the inner height of each div the first time it is clicked (and change its color). ```html innerHeight demo
    d
    d
    d
    d
    d
    ​ ``` */ innerHeight(value_function: string | number | ((this: TElement, index: number, height: number) => string | number)): this; /** * Get the current computed height for the first element in the set of matched elements, including padding but not border. * @see \`{@link https://api.jquery.com/innerHeight/ }\` * @since 1.2.6 * @example ​ ````Get the innerHeight of a paragraph. ```html innerHeight demo

    Hello

    ​ ``` */ innerHeight(): number | undefined; /** * Set the CSS inner width of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
    * * `value` — A number representing the number of pixels, or a number along with an optional unit of measure * appended (as a string).
    * * `function` — A function returning the inner width (including padding but not border) to set. Receives the index * position of the element in the set and the old inner width as arguments. Within the function, `this` * refers to the current element in the set. * @see \`{@link https://api.jquery.com/innerWidth/ }\` * @since 1.8.0 * @example ​ ````Change the inner width of each div the first time it is clicked (and change its color). ```html innerWidth demo
    d
    d
    d
    d
    d
    ​ ``` */ innerWidth(value_function: string | number | ((this: TElement, index: number, width: number) => string | number)): this; /** * Get the current computed inner width for the first element in the set of matched elements, including padding but not border. * @see \`{@link https://api.jquery.com/innerWidth/ }\` * @since 1.2.6 * @example ​ ````Get the innerWidth of a paragraph. ```html innerWidth demo

    Hello

    ​ ``` */ innerWidth(): number | undefined; /** * Insert every element in the set of matched elements after the target. * @param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements * will be inserted after the element(s) specified by this parameter. * @see \`{@link https://api.jquery.com/insertAfter/ }\` * @since 1.0 * @example ​ ````Insert all paragraphs after an element with id of "foo". Same as $( "#foo" ).after( "p" ) ```html insertAfter demo

    is what I said...

    FOO!
    ​ ``` */ insertAfter(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; /** * Insert every element in the set of matched elements before the target. * @param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements * will be inserted before the element(s) specified by this parameter. * @see \`{@link https://api.jquery.com/insertBefore/ }\` * @since 1.0 * @example ​ ````Insert all paragraphs before an element with id of "foo". Same as $( "#foo" ).before( "p" ) ```html insertBefore demo
    FOO!

    I would like to say:

    ​ ``` */ insertBefore(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; /** * Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments. * @param selector_function_selection_elements _@param_ `selector_function_selection_elements` *
    * * `selector` — A string containing a selector expression to match elements against.
    * * `function` — A function used as a test for every element in the set. It accepts two arguments, `index`, which is * the element's index in the jQuery collection, and `element`, which is the DOM element. Within the * function, `this` refers to the current DOM element.
    * * `selection` — An existing jQuery object to match the current set of elements against.
    * * `elements` — One or more elements to match the current set of elements against. * @see \`{@link https://api.jquery.com/is/ }\` * @since 1.0 * @since 1.6 * @example ​ ````Shows a few ways is() can be used inside an event handler. ```html is demo

    Peter

     

    ​ ``` * @example ​ ````Returns true, because the parent of the input is a form element. ```html is demo
    ​ ``` * @example ​ ````Returns false, because the parent of the input is a p element. ```html is demo

    ​ ``` * @example ​ ````Checks against an existing collection of alternating list elements. Blue, alternating list elements slide up while others turn red. ```html is demo
    • Chrome
    • Safari
    • Firefox
    • Opera
    ​ ``` * @example ​ ````An alternate way to achieve the above example using an element rather than a jQuery object. Checks against an existing collection of alternating list elements. Blue, alternating list elements slide up while others turn red. ```html is demo
    • Chrome
    • Safari
    • Firefox
    • Opera
    ​ ``` */ is(selector_function_selection_elements: JQuery.Selector | JQuery.TypeOrArray | JQuery | ((this: TElement, index: number, element: TElement) => boolean)): boolean; /** * Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keydown/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ keydown(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keydown/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the event object for the keydown handler when a key is pressed in the input. ```html keydown demo
    ​ ``` */ keydown(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keypress/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ keypress(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keypress/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the event object when a key is pressed in the input. Note: This demo relies on a simple $.print() plugin (https://api.jquery.com/resources/events.js) for the event object's output. ```html keypress demo
    ​ ``` */ keypress(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keyup/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ keyup(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/keyup/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the event object for the keyup handler (using a simple $.print plugin) when a key is released in the input. ```html keyup demo
    ​ ``` */ keyup(handler?: JQuery.TypeEventHandler | false): this; /** * Reduce the set of matched elements to the final one in the set. * @see \`{@link https://api.jquery.com/last/ }\` * @since 1.4 * @example ​ ````Highlight the last span in a paragraph. ```html last demo

    Look: This is some text in a paragraph. This is a note about it.

    ​ ``` */ last(): this; /** * Reduce the set of matched elements to the even ones in the set, numbered from zero. * @see \`{@link https://api.jquery.com/even/ }\` * @since 3.5 * @example ​ ````Highlight the even items in a list. ```html even demo
    • Look:
    • This is some text in a list.
    • This is a note about it.
    • This is another note about it.
    ``` */ even(): this; /** * Reduce the set of matched elements to the odd ones in the set, numbered from zero. * @see \`{@link https://api.jquery.com/odd/ }\` * @since 3.5 * @example ​ ````Highlight the odd items in a list. ```html odd demo
    • Look:
    • This is some text in a list.
    • This is a note about it.
    • This is another note about it.
    ``` */ odd(): this; /** * Load data from the server and place the returned HTML into the matched element. * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param complete A callback function that is executed when the request completes. * @see \`{@link https://api.jquery.com/load/ }\` * @since 1.0 * @example ​ ````Same as above, but will POST the additional parameters to the server and a callback that is executed when the server is finished responding. ```javascript $( "#feeds" ).load( "feeds.php", { limit: 25 }, function() { alert( "The last 25 entries in the feed have been loaded" ); }); ``` */ load(url: string, data: string | JQuery.PlainObject, complete: (this: TElement, responseText: string, textStatus: JQuery.Ajax.TextStatus, jqXHR: JQuery.jqXHR) => void): this; /** * Load data from the server and place the returned HTML into the matched element. * @param url A string containing the URL to which the request is sent. * @param complete_data _@param_ `complete_data` *
    * * `complete` — A callback function that is executed when the request completes.
    * * `data` — A plain object or string that is sent to the server with the request. * @see \`{@link https://api.jquery.com/load/ }\` * @since 1.0 * @example ​ ````Load another page's list items into an ordered list. ```html load demo Projects:
      ​ ``` * @example ​ ````Display a notice if the Ajax request encounters an error. ```html load demo Successful Response (should be blank):
      Error Response:
      ​ ``` * @example ​ ````Load the feeds.html file into the div with the ID of feeds. ```javascript $( "#feeds" ).load( "feeds.html" ); ``` * @example ​ ````pass arrays of data to the server. ```javascript $( "#objectID" ).load( "test.php", { "choices[]": [ "Jon", "Susan" ] } ); ``` */ load(url: string, complete_data?: ((this: TElement, responseText: string, textStatus: JQuery.Ajax.TextStatus, jqXHR: JQuery.jqXHR) => void) | string | JQuery.PlainObject): this; /** * Pass each element in the current matched set through a function, producing a new jQuery object containing the return values. * @param callback A function object that will be invoked for each element in the current set. * @see \`{@link https://api.jquery.com/map/ }\` * @since 1.2 * @example ​ ````Build a list of all the values within a form. ```html map demo

      Values:

      ​ ``` * @example ​ ````A contrived example to show some functionality. ```html map demo
      • First
      • Second
      • Third
      • Fourth
      • Fifth
      ​ ``` * @example ​ ````Equalize the heights of the divs. ```html map demo
      ​ ``` */ map(callback: (this: TElement, index: number, domElement: TElement) => JQuery.TypeOrArray | null | undefined): JQuery; /** * Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mousedown/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mousedown(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mousedown/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show texts when mouseup and mousedown event triggering. ```html mousedown demo

      Press mouse and release here.

      ​ ``` */ mousedown(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseenter/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mouseenter(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseenter/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show texts when mouseenter and mouseout event triggering. mouseover fires when the pointer moves into the child element as well, while mouseenter fires only when the pointer moves into the bound element. ```html mouseenter demo

      move your mouse

      move your mouse

      0

      0

      move your mouse

      move your mouse

      0

      0

      ​ ``` */ mouseenter(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseleave/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mouseleave(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseleave/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show number of times mouseout and mouseleave events are triggered. mouseout fires when the pointer moves out of child element as well, while mouseleave fires only when the pointer moves out of the bound element. ```html mouseleave demo

      move your mouse

      move your mouse

      0

      0

      move your mouse

      move your mouse

      0

      0

      ​ ``` */ mouseleave(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mousemove/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mousemove(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mousemove/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the mouse coordinates when the mouse is moved over the yellow div. Coordinates are relative to the window, which in this case is the iframe. ```html mousemove demo

      Move the mouse over the div.  

      ​ ``` */ mousemove(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseout/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mouseout(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseout/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the number of times mouseout and mouseleave events are triggered. mouseout fires when the pointer moves out of the child element as well, while mouseleave fires only when the pointer moves out of the bound element. ```html mouseout demo

      move your mouse

      move your mouse

      0

      0

      move your mouse

      move your mouse

      0

      0

      ​ ``` */ mouseout(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseover/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mouseover(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseover/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show the number of times mouseover and mouseenter events are triggered. mouseover fires when the pointer moves into the child element as well, while mouseenter fires only when the pointer moves into the bound element. ```html mouseover demo
      move your mouse
      move your mouse
      ​ ``` */ mouseover(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseup/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ mouseup(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/mouseup/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````Show texts when mouseup and mousedown event triggering. ```html mouseup demo

      Press mouse and release here.

      ​ ``` */ mouseup(handler?: JQuery.TypeEventHandler | false): this; /** * Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/next/ }\` * @since 1.0 * @example ​ ````Find the very next sibling of each disabled button and change its text "this button is disabled". ```html next demo
      -
      -
      -
      ​ ``` * @example ​ ````Find the very next sibling of each paragraph. Keep only the ones with a class "selected". ```html next demo

      Hello

      Hello Again

      And Again
      ​ ``` */ next(selector?: JQuery.Selector): this; /** * Get all following siblings of each element in the set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/nextAll/ }\` * @since 1.2 * @example ​ ````Locate all the divs after the first and give them a class. ```html nextAll demo
      first
      sibling
      child
      sibling
      sibling
      ​ ``` * @example ​ ````Locate all the paragraphs after the second child in the body and give them a class. ```html nextAll demo

      p

      div

      p

      p

      div

      p

      div
      ​ ``` */ nextAll(selector?: string): this; /** * Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed. * @param selector_element _@param_ `selector_element` *
      * * `selector` — A string containing a selector expression to indicate where to stop matching following sibling elements.
      * * `element` — A DOM node or jQuery object indicating where to stop matching following sibling elements. * @param filter A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/nextUntil/ }\` * @since 1.4 * @since 1.6 * @example ​ ````Find the siblings that follow <dt id="term-2"> up to the next <dt> and give them a red background color. Also, find <dd> siblings that follow <dt id="term-1"> up to <dt id="term-3"> and give them a green text color. ```html nextUntil demo
      term 1
      definition 1-a
      definition 1-b
      definition 1-c
      definition 1-d
      term 2
      definition 2-a
      definition 2-b
      definition 2-c
      term 3
      definition 3-a
      definition 3-b
      ​ ``` */ nextUntil(selector_element?: JQuery.Selector | Element | JQuery, filter?: JQuery.Selector): this; /** * Remove elements from the set of matched elements. * @param selector_function_selection _@param_ `selector_function_selection` *
      * * `selector` — A string containing a selector expression, a DOM element, or an array of elements to match against the set.
      * * `function` — A function used as a test for each element in the set. It accepts two arguments, `index`, which is * the element's index in the jQuery collection, and `element`, which is the DOM element. Within the * function, `this` refers to the current DOM element.
      * * `selection` — An existing jQuery object to match the current set of elements against. * @see \`{@link https://api.jquery.com/not/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Adds a border to divs that are not green or blue. ```html not demo
      ​ ``` * @example ​ ````Removes the element with the ID "selected" from the set of all paragraphs. ```javascript $( "p" ).not( $( "#selected" )[ 0 ] ); ``` * @example ​ ````Removes the element with the ID "selected" from the set of all paragraphs. ```javascript $( "p" ).not( "#selected" ); ``` * @example ​ ````Removes all elements that match "div p.selected" from the total set of all paragraphs. ```javascript $( "p" ).not( $( "div p.selected" ) ); ``` */ not(selector_function_selection: JQuery.Selector | JQuery.TypeOrArray | JQuery | ((this: TElement, index: number, element: TElement) => boolean)): this; /** * Remove an event handler. * @param events One or more space-separated event types and optional namespaces, or just namespaces, such as * "click", "keydown.myPlugin", or ".myPlugin". * @param selector A selector which should match the one originally passed to .on() when attaching event handlers. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 * @example ​ ````Add and remove event handlers on the colored button. ```html off demo
      Click!
      ​ ``` * @example ​ ````Remove just one previously bound handler by passing it as the third argument: ```javascript var foo = function() { // Code to handle some kind of event }; ​ // ... Now foo will be called when paragraphs are clicked ... $( "body" ).on( "click", "p", foo ); ​ // ... Foo will no longer be called. $( "body" ).off( "click", "p", foo ); ``` */ off( events: TType, selector: JQuery.Selector, handler: JQuery.TypeEventHandler | false ): this; /** * Remove an event handler. * @param events One or more space-separated event types and optional namespaces, or just namespaces, such as * "click", "keydown.myPlugin", or ".myPlugin". * @param selector_handler _@param_ `selector_handler` *
      * * `selector` — A selector which should match the one originally passed to `.on()` when attaching event handlers.
      * * `handler` — A handler function previously attached for the event(s), or the special value `false`. * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 * @example ​ ````Remove all delegated click handlers from all paragraphs: ```javascript $( "p" ).off( "click", "**" ); ``` * @example ​ ````Unbind all delegated event handlers by their namespace: ```javascript var validate = function() { // Code to validate form entries }; ​ // Delegate events under the ".validator" namespace $( "form" ).on( "click.validator", "button", validate ); ​ $( "form" ).on( "keypress.validator", "input[type='text']", validate ); ​ // Remove event handlers in the ".validator" namespace $( "form" ).off( ".validator" ); ``` */ off( events: TType, selector_handler?: JQuery.Selector | JQuery.TypeEventHandler | false ): this; /** * Remove an event handler. * @param events An object where the string keys represent one or more space-separated event types and optional * namespaces, and the values represent handler functions previously attached for the event(s). * @param selector A selector which should match the one originally passed to .on() when attaching event handlers. * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 */ off(events: JQuery.TypeEventHandlers, selector?: JQuery.Selector): this; /** * Remove an event handler. * @param event A jQuery.Event object. * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 * @example ​ ````Remove all event handlers from all paragraphs: ```javascript $( "p" ).off(); ``` */ off(event?: JQuery.TriggeredEvent): this; /** * Set the current coordinates of every element in the set of matched elements, relative to the document. * @param coordinates_function _@param_ `coordinates_function` *
      * * `coordinates` — An object containing the properties `top` and `left`, which are numbers indicating the new top and * left coordinates for the elements.
      * * `function` — A function to return the coordinates to set. Receives the index of the element in the collection as * the first argument and the current coordinates as the second argument. The function should return an * object with the new `top` and `left` properties. * @see \`{@link https://api.jquery.com/offset/ }\` * @since 1.4 * @example ​ ````Set the offset of the second paragraph: ```html offset demo

      Hello

      2nd Paragraph

      ​ ``` */ offset(coordinates_function: JQuery.CoordinatesPartial | ((this: TElement, index: number, coords: JQuery.Coordinates) => JQuery.CoordinatesPartial)): this; /** * Get the current coordinates of the first element in the set of matched elements, relative to the document. * @see \`{@link https://api.jquery.com/offset/ }\` * @since 1.2 * @example ​ ````Access the offset of the second paragraph: ```html offset demo

      Hello

      2nd Paragraph

      ​ ``` * @example ​ ````Click to see the offset. ```html offset demo
      Click an element.

      This is the best way to find an offset.

      ​ ``` */ offset(): JQuery.Coordinates | undefined; /** * Get the closest ancestor element that is positioned. * @see \`{@link https://api.jquery.com/offsetParent/ }\` * @since 1.2.6 * @example ​ ````Find the offsetParent of item "A." ```html offsetParent demo
      • I
      • II
        • A
        • B
          • 1
          • 2
          • 3
        • C
      • III
      ​ ``` */ offsetParent(): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on( events: TType, selector: JQuery.Selector, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on( events: TType, selector: null | undefined, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\` in place of \`{@link JQueryEventObject }\`. */ on(events: string, selector: JQuery.Selector | null | undefined, data: any, handler: ((event: JQueryEventObject) => void)): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @example ​ ````Click any paragraph to add another after it. Note that .on() allows a click event on any paragraph--even new ones--since the event is handled by the ever-present body element after it bubbles to there. ```html on demo

      Click me!

      ​ ``` * @example ​ ````Display each paragraph's text in an alert box whenever it is clicked: ```javascript $( "body" ).on( "click", "p", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Cancel a link's default action using the .preventDefault() method: ```javascript $( "body" ).on( "click", "a", function( event ) { event.preventDefault(); }); ``` */ on( events: TType, selector: JQuery.Selector, handler: JQuery.TypeEventHandler | false ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @example ​ ````Pass data to the event handler, which is specified here by name: ```javascript function myHandler( event ) { alert( event.data.foo ); } $( "p" ).on( "click", { foo: "bar" }, myHandler ); ``` */ on( events: TType, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector_data _@param_ `selector_data` *
      * * `selector` — A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element.
      * * `data` — Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\` in place of \`{@link JQueryEventObject }\`. * @example ​ ````Click any paragraph to add another after it. Note that .on() allows a click event on any paragraph--even new ones--since the event is handled by the ever-present body element after it bubbles to there. ```html on demo

      Click me!

      ​ ``` * @example ​ ````Display each paragraph's text in an alert box whenever it is clicked: ```javascript $( "body" ).on( "click", "p", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Cancel a link's default action using the .preventDefault() method: ```javascript $( "body" ).on( "click", "a", function( event ) { event.preventDefault(); }); ``` * @example ​ ````Pass data to the event handler, which is specified here by name: ```javascript function myHandler( event ) { alert( event.data.foo ); } $( "p" ).on( "click", { foo: "bar" }, myHandler ); ``` */ on(events: string, selector_data: any, handler: ((event: JQueryEventObject) => void)): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @example ​ ````Display a paragraph's text in an alert when it is clicked: ```javascript $( "p" ).on( "click", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Cancel a form submit action and prevent the event from bubbling up by returning false: ```javascript $( "form" ).on( "submit", false ); ``` * @example ​ ````Cancel only the default action by using .preventDefault(). ```javascript $( "form" ).on( "submit", function( event ) { event.preventDefault(); }); ``` * @example ​ ````Stop submit events from bubbling without preventing form submit, using .stopPropagation(). ```javascript $( "form" ).on( "submit", function( event ) { event.stopPropagation(); }); ``` * @example ​ ````Pass data to the event handler using the second argument to .trigger() ```javascript $( "div" ).on( "click", function( event, person ) { alert( "Hello, " + person.name ); }); $( "div" ).trigger( "click", { name: "Jim" } ); ``` * @example ​ ````Use the the second argument of .trigger() to pass an array of data to the event handler ```javascript $( "div" ).on( "click", function( event, salutation, name ) { alert( salutation + ", " + name ); }); $( "div" ).trigger( "click", [ "Goodbye", "Jim" ] ); ``` * @example ​ ````Attach and trigger custom (non-browser) events. ```html on demo

      Has an attached custom event.

      ​ ``` * @example ​ ````Attach multiple events—one on mouseenter and one on mouseleave to the same element: ```javascript $( "#cart" ).on( "mouseenter mouseleave", function( event ) { $( this ).toggleClass( "active" ); }); ``` */ on( events: TType, handler: JQuery.TypeEventHandler | false ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\` in place of \`{@link JQueryEventObject }\`. * @example ​ ````Display a paragraph's text in an alert when it is clicked: ```javascript $( "p" ).on( "click", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Cancel a form submit action and prevent the event from bubbling up by returning false: ```javascript $( "form" ).on( "submit", false ); ``` * @example ​ ````Cancel only the default action by using .preventDefault(). ```javascript $( "form" ).on( "submit", function( event ) { event.preventDefault(); }); ``` * @example ​ ````Stop submit events from bubbling without preventing form submit, using .stopPropagation(). ```javascript $( "form" ).on( "submit", function( event ) { event.stopPropagation(); }); ``` * @example ​ ````Pass data to the event handler using the second argument to .trigger() ```javascript $( "div" ).on( "click", function( event, person ) { alert( "Hello, " + person.name ); }); $( "div" ).trigger( "click", { name: "Jim" } ); ``` * @example ​ ````Use the the second argument of .trigger() to pass an array of data to the event handler ```javascript $( "div" ).on( "click", function( event, salutation, name ) { alert( salutation + ", " + name ); }); $( "div" ).trigger( "click", [ "Goodbye", "Jim" ] ); ``` * @example ​ ````Attach and trigger custom (non-browser) events. ```html on demo

      Has an attached custom event.

      ​ ``` * @example ​ ````Attach multiple events—one on mouseenter and one on mouseleave to the same element: ```javascript $( "#cart" ).on( "mouseenter mouseleave", function( event ) { $( this ).toggleClass( "active" ); }); ``` */ on(events: string, handler: ((event: JQueryEventObject) => void)): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on( events: JQuery.TypeEventHandlers, selector: JQuery.Selector, data: TData ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on( events: JQuery.TypeEventHandlers, selector: null | undefined, data: TData ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: JQuery.TypeEventHandlers, selector: JQuery.Selector ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on( events: JQuery.TypeEventHandlers, data: TData ): this; /** * Attach an event handler function for one or more events to the selected elements. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 * @example ​ ````Attach multiple event handlers simultaneously using a plain object. ```html on demo
      test div
      ​ ``` */ on(events: JQuery.TypeEventHandlers): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: TType, selector: JQuery.Selector, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: TType, selector: null | undefined, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: TType, selector: JQuery.Selector, handler: JQuery.TypeEventHandler | false ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: TType, data: TData, handler: JQuery.TypeEventHandler ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 * @example ​ ````Tie a one-time click to each div. ```html one demo

      Click a green square...

      ​ ``` * @example ​ ````To display the text of all paragraphs in an alert box the first time each of them is clicked: ```javascript $( "p" ).one( "click", function() { alert( $( this ).text() ); }); ``` * @example ​ ````Event handlers will trigger once per element per event type ```html one demo
      0
      Hover/click me
      ​ ``` */ one( events: TType, handler: JQuery.TypeEventHandler| false ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: JQuery.TypeEventHandlers, selector: JQuery.Selector, data: TData ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: JQuery.TypeEventHandlers, selector: null | undefined, data: TData ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.TypeEventHandlers, selector: JQuery.Selector): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param data Data to be passed to the handler in event.data when an event occurs. * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one( events: JQuery.TypeEventHandlers, data: TData ): this; /** * Attach a handler to an event for the elements. The handler is executed at most once per element per event type. * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.TypeEventHandlers): this; /** * Set the CSS outer height of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
      * * `value` — A number representing the number of pixels, or a number along with an optional unit of measure * appended (as a string).
      * * `function` — A function returning the outer height to set. Receives the index position of the element in the set * and the old outer height as arguments. Within the function, `this` refers to the current element in * the set. * @see \`{@link https://api.jquery.com/outerHeight/ }\` * @since 1.8.0 * @example ​ ````Change the outer height of each div the first time it is clicked (and change its color). ```html outerHeight demo
      d
      d
      d
      d
      d
      ​ ``` */ outerHeight(value_function: string | number | ((this: TElement, index: number, height: number) => string | number), includeMargin?: boolean): this; /** * Get the current computed outer height (including padding, border, and optionally margin) for the first element in the set of matched elements. * @param includeMargin A Boolean indicating whether to include the element's margin in the calculation. * @see \`{@link https://api.jquery.com/outerHeight/ }\` * @since 1.2.6 * @example ​ ````Get the outerHeight of a paragraph. ```html outerHeight demo

      Hello

      ​ ``` */ outerHeight(includeMargin?: boolean): number | undefined; /** * Set the CSS outer width of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
      * * `value` — A number representing the number of pixels, or a number along with an optional unit of measure * appended (as a string).
      * * `function` — A function returning the outer width to set. Receives the index position of the element in the set * and the old outer width as arguments. Within the function, `this` refers to the current element in * the set. * @see \`{@link https://api.jquery.com/outerWidth/ }\` * @since 1.8.0 * @example ​ ````Change the outer width of each div the first time it is clicked (and change its color). ```html outerWidth demo
      d
      d
      d
      d
      d
      ​ ``` */ outerWidth(value_function: string | number | ((this: TElement, index: number, width: number) => string | number), includeMargin?: boolean): this; /** * Get the current computed outer width (including padding, border, and optionally margin) for the first element in the set of matched elements. * @param includeMargin A Boolean indicating whether to include the element's margin in the calculation. * @see \`{@link https://api.jquery.com/outerWidth/ }\` * @since 1.2.6 * @example ​ ````Get the outerWidth of a paragraph. ```html outerWidth demo

      Hello

      ​ ``` */ outerWidth(includeMargin?: boolean): number | undefined; /** * Get the parent of each element in the current set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/parent/ }\` * @since 1.0 * @example ​ ````Shows the parent of each element as (parent > child). Check the View Source to see the raw html. ```html parent demo
      div, span, b

      p, span, em

      div, strong, span, em, b, b
      ​ ``` * @example ​ ````Find the parent element of each paragraph with a class "selected". ```html parent demo

      Hello

      Hello Again

      ​ ``` */ parent(selector?: JQuery.Selector): this; /** * Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/parents/ }\` * @since 1.0 * @example ​ ````Find all parent elements of each b. ```html parents demo

      My parents are:

      ​ ``` * @example ​ ````Click to find all unique div parent elements of each span. ```html parents demo

      Hello
      Hello Again
      And Hello Again

      Click Hellos to toggle their parents. ​ ``` */ parents(selector: K | JQuery): JQuery; parents(selector: K | JQuery): JQuery; // tslint:disable-next-line:no-unnecessary-generics parents(selector?: JQuery.Selector): JQuery; /** * Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object. * @param selector_element _@param_ `selector_element` *
      * * `selector` — A string containing a selector expression to indicate where to stop matching ancestor elements.
      * * `element` — A DOM node or jQuery object indicating where to stop matching ancestor elements. * @param filter A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/parentsUntil/ }\` * @since 1.4 * @since 1.6 * @example ​ ````Find the ancestors of <li class="item-a"> up to <ul class="level-1"> and give them a red background color. Also, find ancestors of <li class="item-2"> that have a class of "yes" up to <ul class="level-1"> and give them a green border. ```html parentsUntil demo
      • I
      • II
        • A
        • B
          • 1
          • 2
          • 3
        • C
      • III
      ​ ``` */ parentsUntil(selector_element?: JQuery.Selector | Element | JQuery, filter?: JQuery.Selector): this; /** * Get the current coordinates of the first element in the set of matched elements, relative to the offset parent. * @see \`{@link https://api.jquery.com/position/ }\` * @since 1.2 * @example ​ ````Access the position of the second paragraph: ```html position demo

      Hello

      ​ ``` */ position(): JQuery.Coordinates; /** * Insert content, specified by the parameter, to the beginning of each element in the set of matched elements. * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert at the beginning of each element in the set of matched elements. * @see \`{@link https://api.jquery.com/prepend/ }\` * @since 1.0 * @example ​ ````Prepends some HTML to all paragraphs. ```html prepend demo

      there, friend!

      amigo!

      ​ ``` * @example ​ ````Prepends a DOM Element to all paragraphs. ```html prepend demo

      is what I'd say

      is what I said

      ​ ``` * @example ​ ````Prepends a jQuery object (similar to an Array of DOM Elements) to all paragraphs. ```html prepend demo

      is what was said.

      Hello ​ ``` */ prepend(...contents: Array>>): this; /** * Insert content, specified by the parameter, to the beginning of each element in the set of matched elements. * @param funсtion A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert at * the beginning of each element in the set of matched elements. Receives the index position of the * element in the set and the old HTML value of the element as arguments. Within the function, `this` * refers to the current element in the set. * @see \`{@link https://api.jquery.com/prepend/ }\` * @since 1.4 */ prepend(funсtion: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; /** * Insert every element in the set of matched elements to the beginning of the target. * @param target A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements * will be inserted at the beginning of the element(s) specified by this parameter. * @see \`{@link https://api.jquery.com/prependTo/ }\` * @since 1.0 * @example ​ ````Prepend all spans to the element with the ID "foo" (Check .prepend() documentation for more examples) ```html prependTo demo
      FOO!
      I have something to say... ​ ``` */ prependTo(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; /** * Get the immediately preceding sibling of each element in the set of matched elements. If a selector is provided, it retrieves the previous sibling only if it matches that selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/prev/ }\` * @since 1.0 * @example ​ ````Find the very previous sibling of each div. ```html prev demo
      has child

      ​ ``` * @example ​ ````For each paragraph, find the very previous sibling that has a class "selected". ```html prev demo
      Hello

      Hello Again

      And Again

      ​ ``` */ prev(selector?: JQuery.Selector): this; /** * Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/prevAll/ }\` * @since 1.2 * @example ​ ````Locate all the divs preceding the last div and give them a class. ```html prevAll demo
      ​ ``` */ prevAll(selector?: JQuery.Selector): this; /** * Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object. * @param selector_element _@param_ `selector_element` *
      * * `selector` — A string containing a selector expression to indicate where to stop matching preceding sibling elements.
      * * `element` — A DOM node or jQuery object indicating where to stop matching preceding sibling elements. * @param filter A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/prevUntil/ }\` * @since 1.4 * @since 1.6 * @example ​ ````Find the siblings that precede <dt id="term-2"> up to the preceding <dt> and give them a red background color. Also, find previous <dd> siblings of <dt id="term-3"> up to <dt id="term-1"> and give them a green text color. ```html prevUntil demo
      term 1
      definition 1-a
      definition 1-b
      definition 1-c
      definition 1-d
      term 2
      definition 2-a
      definition 2-b
      definition 2-c
      term 3
      definition 3-a
      definition 3-b
      ​ ``` */ prevUntil(selector_element?: JQuery.Selector | Element | JQuery, filter?: JQuery.Selector): this; /** * Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished. * @param type The type of queue that needs to be observed. * @param target Object onto which the promise methods have to be attached * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 */ promise(type: string, target: T): T & JQuery.Promise; /** * Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished. * @param target Object onto which the promise methods have to be attached * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 */ promise(target: T): T & JQuery.Promise; /** * Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished. * @param type The type of queue that needs to be observed. * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 * @example ​ ````Using .promise() on a collection with no active animation returns a resolved Promise: ```javascript var div = $( "
      " ); ​ div.promise().done(function( arg1 ) { // Will fire right away and alert "true" alert( this === div && arg1 === div ); }); ``` * @example ​ ````Resolve the returned Promise when all animations have ended (including those initiated in the animation callback or added later on): ```html promise demo

      Ready...

      ​ ``` * @example ​ ````Resolve the returned Promise using a $.when() statement (the .promise() method makes it possible to do this with jQuery collections): ```html promise demo

      Ready...

      ​ ``` */ promise(type?: string): JQuery.Promise; /** * Set one or more properties for the set of matched elements. * @param propertyName The name of the property to set. * @param value_function _@param_ `value_function` *
      * * `value` — A value to set for the property.
      * * `function` — A function returning the value to set. Receives the index position of the element in the set and the * old property value as arguments. Within the function, the keyword `this` refers to the current element. * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 */ prop(propertyName: string, value_function: string | number | boolean | symbol | object | null | undefined | ((this: TElement, index: number, oldPropertyValue: any) => any)): this; /** * Set one or more properties for the set of matched elements. * @param properties An object of property-value pairs to set. * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 * @example ​ ````Disable all checkboxes on the page. ```html prop demo ​ ``` */ prop(properties: JQuery.PlainObject): this; /** * Get the value of a property for the first element in the set of matched elements. * @param propertyName The name of the property to get. * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 * @example ​ ````Display the checked property and attribute of a checkbox as it changes. ```html prop demo

      ​ ``` */ prop(propertyName: string): any; /** * Add a collection of DOM elements onto the jQuery stack. * @param elements An array of elements to push onto the stack and make into a new jQuery object. * @param name The name of a jQuery method that generated the array of elements. * @param args The arguments that were passed in to the jQuery method (for serialization). * @see \`{@link https://api.jquery.com/pushStack/ }\` * @since 1.3 */ pushStack(elements: ArrayLike, name: string, args: any[]): this; /** * Add a collection of DOM elements onto the jQuery stack. * @param elements An array of elements to push onto the stack and make into a new jQuery object. * @see \`{@link https://api.jquery.com/pushStack/ }\` * @since 1.0 * @example ​ ````Add some elements onto the jQuery stack, then pop back off again. ```javascript jQuery([]) .pushStack( document.getElementsByTagName( "div" ) ) .remove() .end(); ``` */ pushStack(elements: ArrayLike): this; /** * Manipulate the queue of functions to be executed, once for each matched element. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @param newQueue The new function to add to the queue, with a function to call that will dequeue the next item. * An array of functions to replace the current queue contents. * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 * @example ​ ````Set a queue array to delete the queue. ```html queue demo
      ​ ``` */ queue(queueName: string, newQueue: JQuery.TypeOrArray>): this; /** * Manipulate the queue of functions to be executed, once for each matched element. * @param newQueue The new function to add to the queue, with a function to call that will dequeue the next item. * An array of functions to replace the current queue contents. * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 * @example ​ ````Queue a custom function. ```html queue demo ​ Click here...
      ​ ``` */ queue(newQueue: JQuery.TypeOrArray>): this; /** * Show the queue of functions to be executed on the matched elements. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 * @example ​ ````Show the length of the queue. ```html queue demo

      The queue length is:

      ​ ``` */ queue(queueName?: string): JQuery.Queue; /** * Specify a function to execute when the DOM is fully loaded. * @param handler A function to execute after the DOM is ready. * @see \`{@link https://api.jquery.com/ready/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.0. Use `jQuery(function() { })`. * @example ​ ````Display a message when the DOM is loaded. ```html ready demo

      Not loaded yet.

      ​ ``` */ ready(handler: ($: JQueryStatic) => void): this; /** * Remove the set of matched elements from the DOM. * @param selector A selector expression that filters the set of matched elements to be removed. * @see \`{@link https://api.jquery.com/remove/ }\` * @since 1.0 * @example ​ ````Removes all paragraphs from the DOM ```html remove demo

      Hello

      how are

      you?

      ​ ``` * @example ​ ````Removes all paragraphs that contain "Hello" from the DOM. Analogous to doing $("p").filter(":contains('Hello')").remove(). ```html remove demo

      Hello

      how are

      you?

      ​ ``` */ remove(selector?: string): this; /** * Remove an attribute from each element in the set of matched elements. * @param attributeName An attribute to remove; as of version 1.7, it can be a space-separated list of attributes. * @see \`{@link https://api.jquery.com/removeAttr/ }\` * @since 1.0 * @example ​ ````Clicking the button changes the title of the input next to it. Move the mouse pointer over the text input to see the effect of adding and removing the title attribute. ```html removeAttr demo
      ​ ``` */ removeAttr(attributeName: string): this; /** * Remove a single class, multiple classes, or all classes from each element in the set of matched elements. * @param className_function _@param_ `className_function` *
      * * `className` — One or more space-separated classes to be removed from the class attribute of each matched element.
      * * `function` — A function returning one or more space-separated class names to be removed. Receives the index * position of the element in the set and the old class value as arguments. * @see \`{@link https://api.jquery.com/removeClass/ }\` * @since 1.0 * @since 1.4 * @since 3.3 * @example ​ ````Remove the class 'blue' from the matched elements. ```html removeClass demo

      Hello

      and

      then

      Goodbye

      ​ ``` * @example ​ ````Remove the class 'blue' and 'under' from the matched elements. ```html removeClass demo

      Hello

      and

      then

      Goodbye

      ​ ``` * @example ​ ````Remove all the classes from the matched elements. ```html removeClass demo

      Hello

      and

      then

      Goodbye

      ​ ``` */ removeClass(className_function?: JQuery.TypeOrArray | ((this: TElement, index: number, className: string) => string)): this; /** * Remove a previously-stored piece of data. * @param name A string naming the piece of data to delete. * An array or space-separated string naming the pieces of data to delete. * @see \`{@link https://api.jquery.com/removeData/ }\` * @since 1.2.3 * @since 1.7 * @example ​ ````Set a data store for 2 names then remove one of them. ```html removeData demo
      value1 before creation:
      value1 after creation:
      value1 after removal:
      value2 after removal:
      ​ ``` */ removeData(name?: JQuery.TypeOrArray): this; /** * Remove a property for the set of matched elements. * @param propertyName The name of the property to remove. * @see \`{@link https://api.jquery.com/removeProp/ }\` * @since 1.6 * @example ​ ````Set a numeric property on a paragraph and then remove it. ```html removeProp demo

      ​ ``` */ removeProp(propertyName: string): this; /** * Replace each target element with the set of matched elements. * @param target A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace. * @see \`{@link https://api.jquery.com/replaceAll/ }\` * @since 1.2 * @example ​ ````Replace all the paragraphs with bold words. ```html replaceAll demo

      Hello

      cruel

      World

      ​ ``` */ replaceAll(target: JQuery.Selector | JQuery | JQuery.TypeOrArray): this; /** * Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed. * @param newContent_function _@param_ `newContent_function` *
      * * `newContent` — The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object.
      * * `function` — A function that returns content with which to replace the set of matched elements. * @see \`{@link https://api.jquery.com/replaceWith/ }\` * @since 1.2 * @since 1.4 * @example ​ ````On click, replace the button with a div containing the same word. ```html replaceWith demo ​ ``` * @example ​ ````Replace all paragraphs with bold words. ```html replaceWith demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````On click, replace each paragraph with a div that is already in the DOM and selected with the $() function. Notice it doesn't clone the object but rather moves it to replace the paragraph. ```html replaceWith demo

      Hello

      cruel

      World

      Replaced!
      ​ ``` * @example ​ ````On button click, replace the containing div with its child divs and append the class name of the selected element to the paragraph. ```html replaceWith demo

      Scooby
      Dooby
      Doo
      ​ ``` */ replaceWith(newContent_function: JQuery.htmlString | JQuery | JQuery.TypeOrArray | JQuery.Node | ((this: TElement, index: number, oldhtml: JQuery.htmlString) => JQuery.htmlString | JQuery | JQuery.TypeOrArray | JQuery.Node)): this; /** * Bind an event handler to the "resize" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/resize/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ resize(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "resize" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/resize/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To see the window width while (or after) it is resized, try: ```javascript $( window ).resize(function() { $( "body" ).prepend( "
      " + $( window ).width() + "
      " ); }); ``` */ resize(handler?: JQuery.TypeEventHandler | false): this; /** * Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/scroll/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ scroll(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/scroll/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To do something when your page is scrolled: ```html scroll demo
      Try scrolling the iframe.

      Paragraph - Scroll happened!

      ​ ``` */ scroll(handler?: JQuery.TypeEventHandler | false): this; /** * Set the current horizontal position of the scroll bar for each of the set of matched elements. * @param value An integer indicating the new position to set the scroll bar to. * @see \`{@link https://api.jquery.com/scrollLeft/ }\` * @since 1.2.6 * @example ​ ````Set the scrollLeft of a div. ```html scrollLeft demo

      lalala

      Hello

      ​ ``` */ scrollLeft(value: number): this; /** * Get the current horizontal position of the scroll bar for the first element in the set of matched elements. * @see \`{@link https://api.jquery.com/scrollLeft/ }\` * @since 1.2.6 * @example ​ ````Get the scrollLeft of a paragraph. ```html scrollLeft demo

      Hello

      ​ ``` */ scrollLeft(): number | undefined; /** * Set the current vertical position of the scroll bar for each of the set of matched elements. * @param value A number indicating the new position to set the scroll bar to. * @see \`{@link https://api.jquery.com/scrollTop/ }\` * @since 1.2.6 * @example ​ ````Set the scrollTop of a div. ```html scrollTop demo

      lalala

      Hello

      ​ ``` */ scrollTop(value: number): this; /** * Get the current vertical position of the scroll bar for the first element in the set of matched elements or set the vertical position of the scroll bar for every matched element. * @see \`{@link https://api.jquery.com/scrollTop/ }\` * @since 1.2.6 * @example ​ ````Get the scrollTop of a paragraph. ```html scrollTop demo

      Hello

      ​ ``` */ scrollTop(): number | undefined; /** * Bind an event handler to the "select" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/select/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ select(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "select" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/select/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````To do something when text in input boxes is selected: ```html select demo

      Click and drag the mouse to select text in the inputs.

      ​ ``` * @example ​ ````To trigger the select event on all input elements, try: ```javascript $( "input" ).select(); ``` */ select(handler?: JQuery.TypeEventHandler | false): this; /** * Encode a set of form elements as a string for submission. * @see \`{@link https://api.jquery.com/serialize/ }\` * @since 1.0 * @example ​ ````Serialize a form to a query string that could be sent to a server in an Ajax request. ```html serialize demo



      ​ ``` */ serialize(): string; /** * Encode a set of form elements as an array of names and values. * @see \`{@link https://api.jquery.com/serializeArray/ }\` * @since 1.2 * @example ​ ````Get the values from a form, iterate through them, and append them to a results display. ```html serializeArray demo

      Results:


      ​ ``` */ serializeArray(): JQuery.NameValuePair[]; /** * Display the matched elements. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.4.3 */ show(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): this; /** * Display the matched elements. * @param duration A string or number determining how long the animation will run. * @param easing_complete _@param_ `easing_complete` *
      * * `easing` — A string indicating which easing function to use for the transition.
      * * `complete` — A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Show the first div, followed by each next adjacent sibling div in order, with a 200ms animation. Each animation starts when the previous sibling div's animation ends. ```html show demo
      Hello 3,
      how
      are
      you?
      ​ ``` * @example ​ ````Show all span and input elements with an animation. Change the text once the animation is done. ```html show demo Are you sure? (type 'yes' if you are)

      I'm hidden...

      ​ ``` */ show(duration: JQuery.Duration, easing_complete: string | ((this: TElement) => void)): this; /** * Display the matched elements. * @param duration_complete_options _@param_ `duration_complete_options` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.0 * @example ​ ````Animates all hidden paragraphs to show slowly, completing the animation within 600 milliseconds. ```html show demo

      Hello 2

      ​ ``` */ show(duration_complete_options?: JQuery.Duration | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Get the siblings of each element in the set of matched elements, optionally filtered by a selector. * @param selector A string containing a selector expression to match elements against. * @see \`{@link https://api.jquery.com/siblings/ }\` * @since 1.0 * @example ​ ````Find the unique siblings of all yellow li elements in the 3 lists (including other yellow li elements if appropriate). ```html siblings demo
      • One
      • Two
      • Three
      • Four
      • Five
      • Six
      • Seven
      • Eight
      • Nine
      • Ten
      • Eleven

      Unique siblings:

      ​ ``` * @example ​ ````Find all siblings with a class "selected" of each div. ```html siblings demo
      Hello

      Hello Again

      And Again

      ​ ``` */ siblings(selector?: JQuery.Selector): this; /** * Reduce the set of matched elements to a subset specified by a range of indices. * @param start An integer indicating the 0-based position at which the elements begin to be selected. If negative, * it indicates an offset from the end of the set. * @param end An integer indicating the 0-based position at which the elements stop being selected. If negative, * it indicates an offset from the end of the set. If omitted, the range continues until the end of the set. * @see \`{@link https://api.jquery.com/slice/ }\` * @since 1.1.4 * @example ​ ````Turns divs yellow based on a random slice. ```html slice demo

      Click the button!

      ​ ``` * @example ​ ````Selects all paragraphs, then slices the selection to include only the first element. ```javascript $( "p" ).slice( 0, 1 ).wrapInner( "" ); ``` * @example ​ ````Selects all paragraphs, then slices the selection to include only the first and second element. ```javascript $( "p" ).slice( 0, 2 ).wrapInner( "" ); ``` * @example ​ ````Selects all paragraphs, then slices the selection to include only the second element. ```javascript $( "p" ).slice( 1, 2 ).wrapInner( "" ); ``` * @example ​ ````Selects all paragraphs, then slices the selection to include only the second and third element. ```javascript $( "p" ).slice( 1 ).wrapInner( "" ); ``` * @example ​ ````Selects all paragraphs, then slices the selection to include only the third element. ```javascript $( "p" ).slice( -1 ).wrapInner( "" ); ``` */ slice(start: number, end?: number): this; /** * Display the matched elements with a sliding motion. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.4.3 */ slideDown(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Display the matched elements with a sliding motion. * @param duration_easing _@param_ `duration_easing` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all inputs to slide down, completing the animation within 1000 milliseconds. Once the animation is done, the input look is changed especially if it is the middle input which gets the focus. ```html slideDown demo
      Push!
      ​ ``` */ slideDown(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Display the matched elements with a sliding motion. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all divs to slide down and show themselves over 600 milliseconds. ```html slideDown demo ​ Click me!
      ​ ``` */ slideDown(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Display or hide the matched elements with a sliding motion. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.4.3 */ slideToggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Display or hide the matched elements with a sliding motion. * @param duration_easing _@param_ `duration_easing` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates divs between dividers with a toggle that makes some appear and some disappear. ```html slideToggle demo

      There have been 0 toggled divs.

      ​ ``` */ slideToggle(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Display or hide the matched elements with a sliding motion. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all paragraphs to slide up or down, completing the animation within 600 milliseconds. ```html slideToggle demo

      This is the paragraph to end all paragraphs. You should feel lucky to have seen such a paragraph in your life. Congratulations!

      ​ ``` */ slideToggle(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Hide the matched elements with a sliding motion. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.4.3 */ slideUp(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Hide the matched elements with a sliding motion. * @param duration_easing _@param_ `duration_easing` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates the parent paragraph to slide up, completing the animation within 200 milliseconds. Once the animation is done, it displays an alert. ```html slideUp demo
      ​ ``` */ slideUp(duration_easing: JQuery.Duration | string, complete: (this: TElement) => void): this; /** * Hide the matched elements with a sliding motion. * @param duration_easing_complete_options _@param_ `duration_easing_complete_options` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `easing` — A string indicating which easing function to use for the transition.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `options` — A map of additional options to pass to the method. * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.0 * @since 1.4.3 * @example ​ ````Animates all divs to slide up, completing the animation within 400 milliseconds. ```html slideUp demo ​ Click me!
      ​ ``` */ slideUp(duration_easing_complete_options?: JQuery.Duration | string | ((this: TElement) => void) | JQuery.EffectsOptions): this; /** * Stop the currently-running animation on the matched elements. * @param queue The name of the queue in which to stop animations. * @param clearQueue A Boolean indicating whether to remove queued animation as well. Defaults to false. * @param jumpToEnd A Boolean indicating whether to complete the current animation immediately. Defaults to false. * @see \`{@link https://api.jquery.com/stop/ }\` * @since 1.7 */ stop(queue: string, clearQueue?: boolean, jumpToEnd?: boolean): this; /** * Stop the currently-running animation on the matched elements. * @param clearQueue A Boolean indicating whether to remove queued animation as well. Defaults to false. * @param jumpToEnd A Boolean indicating whether to complete the current animation immediately. Defaults to false. * @see \`{@link https://api.jquery.com/stop/ }\` * @since 1.2 * @example ​ ````Click the Go button once to start the animation, then click the STOP button to stop it where it's currently positioned. Another option is to click several buttons to queue them up and see that stop just kills the currently playing one. ```html stop demo
      ​ ``` * @example ​ ````Click the slideToggle button to start the animation, then click again before the animation is completed. The animation will toggle the other direction from the saved starting point. ```html stop demo
      ​ ``` */ stop(clearQueue?: boolean, jumpToEnd?: boolean): this; /** * Bind an event handler to the "submit" JavaScript event, or trigger that event on an element. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/submit/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. */ submit(eventData: TData, handler: JQuery.TypeEventHandler): this; /** * Bind an event handler to the "submit" JavaScript event, or trigger that event on an element. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/submit/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.3. Use \`{@link on }\` or \`{@link trigger }\`. * * **Cause**: The `.on()` and `.trigger()` methods can set an event handler or generate an event for any event type, and should be used instead of the shortcut methods. This message also applies to the other event shorthands, including: blur, focus, focusin, focusout, resize, scroll, dblclick, mousedown, mouseup, mousemove, mouseover, mouseout, mouseenter, mouseleave, change, select, submit, keydown, keypress, keyup, and contextmenu. * * **Solution**: Instead of `.click(fn)` use `.on("click", fn)`. Instead of `.click()` use `.trigger("click")`. * @example ​ ````If you'd like to prevent forms from being submitted unless a flag variable is set, try: ```html submit demo

      Type 'correct' to validate.

      ​ ``` * @example ​ ````If you'd like to prevent forms from being submitted unless a flag variable is set, try: ```javascript $( "form" ).submit(function() { return this.some_flag_variable; }); ``` * @example ​ ````To trigger the submit event on the first form on the page, try: ```javascript $( "form:first" ).submit(); ``` */ submit(handler?: JQuery.TypeEventHandler | false): this; /** * Set the content of each element in the set of matched elements to the specified text. * @param text_function _@param_ `text_function` *
      * * `text` — The text to set as the content of each matched element. When Number or Boolean is supplied, it will * be converted to a String representation.
      * * `function` — A function returning the text content to set. Receives the index position of the element in the set * and the old text value as arguments. * @see \`{@link https://api.jquery.com/text/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Add text to the paragraph (notice the bold tag is escaped). ```html text demo

      Test Paragraph.

      ​ ``` */ text(text_function: string | number | boolean | ((this: TElement, index: number, text: string) => string | number | boolean)): this; /** * Get the combined text contents of each element in the set of matched elements, including their descendants. * @see \`{@link https://api.jquery.com/text/ }\` * @since 1.0 * @example ​ ````Find the text in the first paragraph (stripping out the html), then set the html of the last paragraph to show it is just text (the red bold is gone). ```html text demo

      Test Paragraph.

      ​ ``` */ text(): string; /** * Retrieve all the elements contained in the jQuery set, as an array. * @see \`{@link https://api.jquery.com/toArray/ }\` * @since 1.4 * @example ​ ````Select all divs in the document and return the DOM Elements as an Array; then use the built-in reverse() method to reverse that array. ```html toArray demo ​ Reversed -
      One
      Two
      Three
      ​ ``` */ toArray(): TElement[]; /** * Display or hide the matched elements. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.4.3 */ toggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; /** * Display or hide the matched elements. * @param duration A string or number determining how long the animation will run. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.0 */ toggle(duration: JQuery.Duration, complete: (this: TElement) => void): this; /** * Display or hide the matched elements. * @param duration_complete_options_display _@param_ `duration_complete_options_display` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `options` — A map of additional options to pass to the method.
      * * `display` — Use true to show the element or false to hide it. * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.0 * @since 1.3 * @example ​ ````Toggles all paragraphs. ```html toggle demo

      Hello

      Good Bye

      ​ ``` * @example ​ ````Animates all paragraphs to be shown if they are hidden and hidden if they are visible, completing the animation within 600 milliseconds. ```html toggle demo

      Hiya

      Such interesting text, eh?

      ​ ``` * @example ​ ````Shows all paragraphs, then hides them all, back and forth. ```html toggle demo

      Hello

      Good Bye

      ​ ``` */ toggle(duration_complete_options_display?: JQuery.Duration | ((this: TElement) => void) | JQuery.EffectsOptions | boolean): this; /** * Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument. * @param className_function _@param_ `className_function` *
      * * `className` — One or more class names (separated by spaces) to be toggled for each element in the matched set.
      * * `function` — A function that returns class names to be toggled in the class attribute of each element in the * matched set. Receives the index position of the element in the set, the old class value, and the state as arguments. * @param state A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed. * @see \`{@link https://api.jquery.com/toggleClass/ }\` * @since 1.0 * @since 1.3 * @since 1.4 * @since 3.3 * @example ​ ````Toggle the class 'highlight' when a paragraph is clicked. ```html toggleClass demo

      Click to toggle

      highlight

      on these

      paragraphs

      ​ ``` * @example ​ ````Add the "highlight" class to the clicked paragraph on every third click of that paragraph, remove it every first and second click. ```html toggleClass demo

      Click to toggle (clicks: 0)

      highlight (clicks: 0)

      on these (clicks: 0)

      paragraphs (clicks: 0)

      ​ ``` * @example ​ ````Toggle the class name(s) indicated on the buttons for each div. ```html toggleClass demo
      reset
      ​ ``` */ toggleClass(className_function: JQuery.TypeOrArray | ((this: TElement, index: number, className: string, state: TState) => string), state?: TState): this; /** * Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument. * @param state A boolean value to determine whether the class should be added or removed. * @see \`{@link https://api.jquery.com/toggleClass/ }\` * @since 1.4 * @deprecated ​ Deprecated since 3.0. See \`{@link https://github.com/jquery/jquery/pull/2618 }\`. * * **Cause**: Calling `.toggleClass()` with no arguments, or with a single Boolean `true` or `false` argument, has been deprecated. Its behavior was poorly documented, but essentially the method saved away the current class value in a data item when the class was removed and restored the saved value when it was toggled back. If you do not believe you are specificially trying to use this form of the method, it is possible you are accidentally doing so via an inadvertent undefined value, as `.toggleClass( undefined )` toggles all classes. * * **Solution**: If this functionality is still needed, save the current full `.attr( "class" )` value in a data item and restore it when required. */ toggleClass(state?: boolean): this; /** * Execute all handlers and behaviors attached to the matched elements for the given event type. * @param eventType_event _@param_ `eventType_event` *
      * * `eventType` — A string containing a JavaScript event type, such as `click` or `submit`.
      * * `event` — A \`{@link https://api.jquery.com/category/events/event-object/ jQuery.Event}\` object. * @param extraParameters Additional parameters to pass along to the event handler. * @see \`{@link https://api.jquery.com/trigger/ }\` * @since 1.0 * @since 1.3 * @example ​ ````Clicks to button #2 also trigger a click for button #1. ```html trigger demo
      0 button #1 clicks.
      0 button #2 clicks.
      ​ ``` * @example ​ ````To submit the first form without using the submit() function, try: ```javascript $( "form:first" ).trigger( "submit" ); ``` * @example ​ ````To submit the first form without using the submit() function, try: ```javascript var event = jQuery.Event( "submit" ); $( "form:first" ).trigger( event ); if ( event.isDefaultPrevented() ) { // Perform an action... } ``` * @example ​ ````To pass arbitrary data to an event: ```javascript $( "p" ) .click(function( event, a, b ) { // When a normal click fires, a and b are undefined // for a trigger like below a refers to "foo" and b refers to "bar" }) .trigger( "click", [ "foo", "bar" ] ); ``` * @example ​ ````To pass arbitrary data through an event object: ```javascript var event = jQuery.Event( "logged" ); event.user = "foo"; event.pass = "bar"; $( "body" ).trigger( event ); ``` * @example ​ ````Alternative way to pass data through an event object: ```javascript $( "body" ).trigger({ type:"logged", user:"foo", pass:"bar" }); ``` */ trigger(eventType_event: string | JQuery.Event, extraParameters?: any[] | JQuery.PlainObject | string | number | boolean): this; /** * Execute all handlers attached to an element for an event. * @param eventType_event _@param_ `eventType_event` *
      * * `eventType` — A string containing a JavaScript event type, such as `click` or `submit`.
      * * `event` — A \`{@link https://api.jquery.com/category/events/event-object/ jQuery.Event}\` object. * @param extraParameters Additional parameters to pass along to the event handler. * @see \`{@link https://api.jquery.com/triggerHandler/ }\` * @since 1.2 * @since 1.3 * @example ​ ````If you called .triggerHandler() on a focus event - the browser's default focus action would not be triggered, only the event handlers bound to the focus event. ```html triggerHandler demo

      ​ ``` */ triggerHandler(eventType_event: string | JQuery.Event, extraParameters?: any[] | JQuery.PlainObject | string | number | boolean): any; /** * Remove a previously-attached event handler from the elements. * @param event A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/unbind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. Use \`{@link off }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````Can bind and unbind events to the colored button. ```html unbind demo
      Click!
      ​ ``` * @example ​ ````To unbind just one previously bound handler, pass the function in as the second argument: ```javascript var foo = function() { // Code to handle some kind of event }; ​ $( "p" ).bind( "click", foo ); // ... Now foo will be called when paragraphs are clicked ... ​ $( "p" ).unbind( "click", foo ); // ... foo will no longer be called. ``` */ unbind( event: TType, handler: JQuery.TypeEventHandler | false ): this; /** * Remove a previously-attached event handler from the elements. * @param event A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * A jQuery.Event object. * @see \`{@link https://api.jquery.com/unbind/ }\` * @since 1.0 * @deprecated ​ Deprecated since 3.0. Use \`{@link off }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````To unbind all events from all paragraphs, write: ```javascript $( "p" ).unbind(); ``` * @example ​ ````To unbind all click events from all paragraphs, write: ```javascript $( "p" ).unbind( "click" ); ``` */ unbind(event?: string | JQuery.TriggeredEvent): this; /** * Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements. * @param selector A selector which will be used to filter the event results. * @param eventType A string containing a JavaScript event type, such as "click" or "keydown" * @param handler A function to execute each time the event is triggered. * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @deprecated ​ Deprecated since 3.0. Use \`{@link off }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````Can bind and unbind events to the colored button. ```html undelegate demo
      Click!
      ​ ``` * @example ​ ````To undelegate just one previously bound handler, pass the function in as the third argument: ```javascript var foo = function () { // Code to handle some kind of event }; ​ // ... Now foo will be called when paragraphs are clicked ... $( "body" ).delegate( "p", "click", foo ); ​ // ... foo will no longer be called. $( "body" ).undelegate( "p", "click", foo ); ``` */ undelegate( selector: JQuery.Selector, eventType: TType, handler: JQuery.TypeEventHandler | false ): this; /** * Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements. * @param selector A selector which will be used to filter the event results. * @param eventType_events _@param_ `eventType_events` *
      * * `eventType` — A string containing a JavaScript event type, such as "click" or "keydown"
      * * `events` — An object of one or more event types and previously bound functions to unbind from them. * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. Use \`{@link off }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. */ undelegate(selector: JQuery.Selector, eventType_events: string | JQuery.TypeEventHandlers): this; /** * Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements. * @param namespace A selector which will be used to filter the event results. * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @since 1.6 * @deprecated ​ Deprecated since 3.0. Use \`{@link off }\`. * * **Cause**: These event binding methods have been deprecated in favor of the `.on()` and `.off()` methods which can handle both delegated and direct event binding. Although the older methods are still present in jQuery 3.0, they may be removed as early as the next major-version update. * * **Solution**: Change the method call to use `.on()` or `.off()`, the documentation for the old methods include specific instructions. In general, the `.bind()` and `.unbind()` methods can be renamed directly to `.on()` and `.off()` respectively since the argument orders are identical. * @example ​ ````To unbind all delegated events from all paragraphs, write: ```javascript $( "p" ).undelegate(); ``` * @example ​ ````To unbind all delegated click events from all paragraphs, write: ```javascript $( "p" ).undelegate( "click" ); ``` * @example ​ ````To unbind all delegated events by their namespace: ```javascript var foo = function() { // Code to handle some kind of event }; ​ // Delegate events under the ".whatever" namespace $( "form" ).delegate( ":button", "click.whatever", foo ); ​ $( "form" ).delegate( "input[type='text'] ", "keypress.whatever", foo ); ​ // Unbind all events delegated under the ".whatever" namespace $( "form" ).undelegate( ".whatever" ); ``` */ undelegate(namespace?: string): this; /** * Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place. * @param selector A selector to check the parent element against. If an element's parent does not match the selector, * the element won't be unwrapped. * @see \`{@link https://api.jquery.com/unwrap/ }\` * @since 1.4 * @since 3.0 * @example ​ ````Wrap/unwrap a div around each of the paragraphs. ```html unwrap demo

      Hello

      cruel

      World

      ​ ``` */ unwrap(selector?: string): this; /** * Set the value of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
      * * `value` — A string of text, a number, or an array of strings corresponding to the value of each matched * element to set as selected/checked.
      * * `function` — A function returning the value to set. `this` is the current element. Receives the index position of * the element in the set and the old value as arguments. * @see \`{@link https://api.jquery.com/val/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Set the value of an input box. ```html val demo
      ​ ``` * @example ​ ````Use the function argument to modify the value of an input box. ```html val demo

      Type something and then click or tab out of the input.

      ​ ``` * @example ​ ````Set a single select, a multiple select, checkboxes and a radio button . ```html val demo
      check1 check2 radio1 radio2 ​ ​ ``` */ val(value_function: string | number | string[] | ((this: TElement, index: number, value: string) => string)): this; /** * Get the current value of the first element in the set of matched elements. * @see \`{@link https://api.jquery.com/val/ }\` * @since 1.0 * @example ​ ````Get the single value from a single select and an array of values from a multiple select and display their values. ```html val demo

      ​ ``` * @example ​ ````Find the value of an input box. ```html val demo

      ​ ``` */ val(): string | number | string[] | undefined; /** * Set the CSS width of each element in the set of matched elements. * @param value_function _@param_ `value_function` *
      * * `value` — An integer representing the number of pixels, or an integer along with an optional unit of measure * appended (as a string).
      * * `function` — A function returning the width to set. Receives the index position of the element in the set and the * old width as arguments. Within the function, `this` refers to the current element in the set. * @see \`{@link https://api.jquery.com/width/ }\` * @since 1.0 * @since 1.4.1 * @example ​ ````Change the width of each div the first time it is clicked (and change its color). ```html width demo
      d
      d
      d
      d
      d
      ​ ``` */ width(value_function: string | number | ((this: TElement, index: number, value: number) => string | number)): this; /** * Get the current computed width for the first element in the set of matched elements. * @see \`{@link https://api.jquery.com/width/ }\` * @since 1.0 * @example ​ ````Show various widths. Note the values are from the iframe so might be smaller than you expected. The yellow highlight shows the iframe body. ```html width demo
       

      Sample paragraph to test width

      ​ ``` */ width(): number | undefined; /** * Wrap an HTML structure around each element in the set of matched elements. * @param wrappingElement_function _@param_ `wrappingElement_function` *
      * * `wrappingElement` — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the * matched elements. When you pass a jQuery collection containing more than one element, or a selector * matching more than one element, the first element will be used.
      * * `function` — A callback function returning the HTML content or jQuery object to wrap around the matched elements. * Receives the index position of the element in the set as an argument. Within the function, `this` * refers to the current element in the set. * @see \`{@link https://api.jquery.com/wrap/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Wrap a new div around all of the paragraphs. ```html wrap demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Wraps a newly created tree of objects around the spans. Notice anything in between the spans gets left out like the <strong> (red text) in this example. Even the white space between spans is left out. Click View Source to see the original html.> ```html wrap demo Span Text What about me? Another One ​ ``` * @example ​ ````Wrap a new div around all of the paragraphs. ```html wrap demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Wrap a jQuery object double depth div around all of the paragraphs. Notice it doesn't move the object but just clones it to wrap around its target. ```html wrap demo

      Hello

      cruel

      World

      ​ ``` */ wrap(wrappingElement_function: JQuery.Selector | JQuery.htmlString | Element | JQuery | ((this: TElement, index: number) => string | JQuery)): this; /** * Wrap an HTML structure around all elements in the set of matched elements. * @param wrappingElement_function _@param_ `wrappingElement_function` *
      * * `wrappingElement` — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.
      * * `function` — A callback function returning the HTML content or jQuery object to wrap around all the matched * elements. Within the function, `this` refers to the first element in the set. **Prior to jQuery * 3.0**, the callback was incorrectly called for every element in the set and received the index * position of the element in the set as an argument. * @see \`{@link https://api.jquery.com/wrapAll/ }\` * @since 1.2 * @since 1.4 * @example ​ ````Wrap a new div around all of the paragraphs. ```html wrapAll demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Wraps a newly created tree of objects around the spans. Notice anything in between the spans gets left out like the <strong> (red text) in this example. Even the white space between spans is left out. Click View Source to see the original html. ```html wrapAll demo Span Text What about me? Another One ​ ``` * @example ​ ````Wrap a new div around all of the paragraphs. ```html wrapAll demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Wrap a jQuery object double depth div around all of the paragraphs. Notice it doesn't move the object but just clones it to wrap around its target. ```html wrapAll demo

      Hello

      cruel

      World

      ​ ``` */ wrapAll(wrappingElement_function: JQuery.Selector | JQuery.htmlString | Element | JQuery | ((this: TElement) => string | JQuery)): this; /** * Wrap an HTML structure around the content of each element in the set of matched elements. * @param wrappingElement_function _@param_ `wrappingElement_function` *
      * * `wrappingElement` — An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap * around the content of the matched elements.
      * * `function` — A callback function which generates a structure to wrap around the content of the matched elements. * Receives the index position of the element in the set as an argument. Within the function, `this` * refers to the current element in the set. * @see \`{@link https://api.jquery.com/wrapInner/ }\` * @since 1.2 * @since 1.4 * @example ​ ````Selects all paragraphs and wraps a bold tag around each of its contents. ```html wrapInner demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Wraps a newly created tree of objects around the inside of the body. ```html wrapInner demo ​ Plain old text, or is it? ​ ​ ``` * @example ​ ````Selects all paragraphs and wraps a bold tag around each of its contents. ```html wrapInner demo

      Hello

      cruel

      World

      ​ ``` * @example ​ ````Selects all paragraphs and wraps a jQuery object around each of its contents. ```html wrapInner demo

      Hello

      cruel

      World

      ​ ``` */ wrapInner(wrappingElement_function: JQuery.Selector | JQuery.htmlString | Element | JQuery | ((this: TElement, index: number) => string | JQuery | Element)): this; [n: number]: TElement; } // tslint:disable:jsdoc-format // tslint:disable:max-line-length // tslint:disable:no-irregular-whitespace interface JQueryStatic { /** * @see \`{@link https://api.jquery.com/jquery.ajax/#jQuery-ajax1 }\` * @deprecated ​ Deprecated. Use \`{@link ajaxSetup }\`. */ ajaxSettings: JQuery.AjaxSettings; Animation: JQuery.AnimationStatic; Callbacks: JQuery.CallbacksStatic; /** * Hook directly into jQuery to override how particular CSS properties are retrieved or set, normalize CSS property naming, or create custom properties. * @see \`{@link https://api.jquery.com/jQuery.cssHooks/ }\` * @since 1.4.3 */ cssHooks: JQuery.CSSHooks; /** * An object containing all CSS properties that may be used without a unit. The .css() method uses this object to see if it may append px to unitless values. * @see \`{@link https://api.jquery.com/jQuery.cssNumber/ }\` * @since 1.4.3 */ cssNumber: JQuery.PlainObject; Deferred: JQuery.DeferredStatic; easing: JQuery.Easings; Event: JQuery.EventStatic; /** * @see \`{@link https://learn.jquery.com/events/event-extensions/ }\` */ event: JQuery.EventExtensions; expr: JQuery.Selectors; // Set to HTMLElement to minimize breaks but should probably be Element. readonly fn: JQuery; fx: JQuery.Effects; /** * A Promise-like object (or "thenable") that resolves when the document is ready. * @see \`{@link https://api.jquery.com/jQuery.ready/ }\` * @since 1.8 * @example ​ ````Listen for document ready using jQuery.when. ```javascript $.when( $.ready ).then(function() { // Document is ready. }); ``` * @example ​ ````Typical usage involving another promise, using jQuery.when. ```javascript $.when( $.getJSON( "ajax/test.json" ), $.ready ).done(function( data ) { // Document is ready. // Value of test.json is passed as `data`. }); ``` */ ready: JQuery.Thenable; /** * A collection of properties that represent the presence of different browser features or bugs. Intended for jQuery's internal use; specific properties may be removed when they are no longer needed internally to improve page startup performance. For your own project's feature-detection needs, we strongly recommend the use of an external library such as Modernizr instead of dependency on properties in jQuery.support. * @see \`{@link https://api.jquery.com/jQuery.support/ }\` * @since 1.3 * @deprecated ​ Deprecated since 1.9. See \`{@link https://api.jquery.com/jQuery.support/ }\`. */ support: JQuery.PlainObject; timers: Array>; Tween: JQuery.TweenStatic; valHooks: JQuery.ValHooks; // HACK: This is the factory function returned when importing jQuery without a DOM. Declaring it separately breaks using the type parameter on JQueryStatic. // HACK: The discriminator parameter handles the edge case of passing a Window object to JQueryStatic. It doesn't actually exist on the factory function. (window: Window, discriminator: boolean): JQueryStatic; /** * Creates DOM elements on the fly from the provided string of raw HTML. * @param html _@param_ `html` *
      * * `html (ownerDocument)` — A string of HTML to create on the fly. Note that this parses HTML, not XML.
      * * `html (attributes)` — A string defining a single, standalone, HTML element (e.g. <div/> or <div></div>). * @param ownerDocument_attributes _@param_ `ownerDocument_attributes` *
      * * `ownerDocument` — A document in which the new elements will be created.
      * * `attributes` — An object of attributes, events, and methods to call on the newly-created element. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @since 1.4 * @example ​ ````Create a div element (and all of its contents) dynamically and append it to the body element. Internally, an element is created and its innerHTML property set to the given markup. ```javascript $( "

      Hello

      " ).appendTo( "body" ) ``` * @example ​ ````Create some DOM elements. ```javascript $( "
      ", { "class": "test", text: "Click me!", click: function() { $( this ).toggleClass( "test" ); } }) .appendTo( "body" ); ``` */ // tslint:disable-next-line:no-unnecessary-generics (html: JQuery.htmlString, ownerDocument_attributes?: Document | JQuery.PlainObject): JQuery; /** * Accepts a string containing a CSS selector which is then used to match a set of elements. * @param selector A string containing a selector expression * @param context A DOM Element, Document, Selector or jQuery to use as context * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @example ​ ````Find all p elements that are children of a div element and apply a border to them. ```html jQuery demo

      one

      two

      three

      ``` * @example ​ ````Find all inputs of type radio within the first form in the document. ```javascript $( "input:radio", document.forms[ 0 ] ); ``` * @example ​ ````Find all div elements within an XML document from an Ajax response. ```javascript $( "div", xml.responseXML ); ``` ​ */ // tslint:disable-next-line:no-unnecessary-generics (selector: JQuery.Selector, context?: Element | Document | JQuery | JQuery.Selector): JQuery; /** * Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string. * @param element A DOM element to wrap in a jQuery object. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @example ​ ````Set the background color of the page to black. ```javascript $( document.body ).css( "background", "black" ); ``` */ // NOTE: `HTMLSelectElement` is both an Element and an Array-Like Object but jQuery treats it as an Element. (element: HTMLSelectElement): JQuery; /** * Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string. * @param element_elementArray _@param_ `element_elementArray` *
      * * `element` — A DOM element to wrap in a jQuery object.
      * * `elementArray` — An array containing a set of DOM elements to wrap in a jQuery object. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @example ​ ````Set the background color of the page to black. ```javascript $( document.body ).css( "background", "black" ); ``` * @example ​ ````Hide all the input elements within a form. ```javascript $( myForm.elements ).hide(); ``` */ (element_elementArray: T | ArrayLike): JQuery; /** * Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string. * @param selection An existing jQuery object to clone. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 */ (selection: JQuery): JQuery; /** * Binds a function to be executed when the DOM has finished loading. * @param callback The function to execute when the DOM is ready. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @example ​ ````Execute the function when the DOM is ready to be used. ```javascript $(function() { // Document is ready }); ``` * @example ​ ````Use both the shortcut for $(document).ready() and the argument to write failsafe jQuery code using the $ alias, without relying on the global alias. ```javascript jQuery(function( $ ) { // Your code using failsafe $ alias here... }); ``` */ // tslint:disable-next-line:no-unnecessary-generics unified-signatures (callback: ((this: Document, $: JQueryStatic) => void)): JQuery; /** * Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string. * @param object A plain object to wrap in a jQuery object. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 */ (object: T): JQuery; /** * Returns an empty jQuery set. * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.4 */ // tslint:disable-next-line:no-unnecessary-generics (): JQuery; /** * Perform an asynchronous HTTP (Ajax) request. * @param url A string containing the URL to which the request is sent. * @param settings A set of key/value pairs that configure the Ajax request. All settings are optional. A default can * be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) below for a complete list of all settings. * @see \`{@link https://api.jquery.com/jQuery.ajax/ }\` * @since 1.5 */ ajax(url: string, settings?: JQuery.AjaxSettings): JQuery.jqXHR; /** * Perform an asynchronous HTTP (Ajax) request. * @param settings A set of key/value pairs that configure the Ajax request. All settings are optional. A default can * be set for any option with $.ajaxSetup(). * @see \`{@link https://api.jquery.com/jQuery.ajax/ }\` * @since 1.0 * @example ​ ````Save some data to the server and notify the user once it's complete. ```javascript $.ajax({ method: "POST", url: "some.php", data: { name: "John", location: "Boston" } }) .done(function( msg ) { alert( "Data Saved: " + msg ); }); ``` * @example ​ ````Retrieve the latest version of an HTML page. ```javascript $.ajax({ url: "test.html", cache: false }) .done(function( html ) { $( "#results" ).append( html ); }); ``` * @example ​ ````Send an xml document as data to the server. By setting the processData option to false, the automatic conversion of data to strings is prevented. ```javascript var xmlDocument = [create xml document]; var xmlRequest = $.ajax({ url: "page.php", processData: false, data: xmlDocument }); ​ xmlRequest.done( handleResponse ); ``` * @example ​ ````Send an id as data to the server, save some data to the server, and notify the user once it's complete. If the request fails, alert the user. ```javascript var menuId = $( "ul.nav" ).first().attr( "id" ); var request = $.ajax({ url: "script.php", method: "POST", data: { id : menuId }, dataType: "html" }); ​ request.done(function( msg ) { $( "#log" ).html( msg ); }); ​ request.fail(function( jqXHR, textStatus ) { alert( "Request failed: " + textStatus ); }); ``` * @example ​ ````Load and execute a JavaScript file. ```javascript $.ajax({ method: "GET", url: "test.js", dataType: "script" }); ``` */ ajax(settings?: JQuery.AjaxSettings): JQuery.jqXHR; /** * Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax(). * @param dataTypes An optional string containing one or more space-separated dataTypes * @param handler A handler to set default values for future Ajax requests. * @see \`{@link https://api.jquery.com/jQuery.ajaxPrefilter/ }\` * @since 1.5 */ ajaxPrefilter(dataTypes: string, handler: (options: JQuery.AjaxSettings, originalOptions: JQuery.AjaxSettings, jqXHR: JQuery.jqXHR) => string | void): void; /** * Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax(). * @param handler A handler to set default values for future Ajax requests. * @see \`{@link https://api.jquery.com/jQuery.ajaxPrefilter/ }\` * @since 1.5 */ ajaxPrefilter(handler: (options: JQuery.AjaxSettings, originalOptions: JQuery.AjaxSettings, jqXHR: JQuery.jqXHR) => string | void): void; /** * Set default values for future Ajax requests. Its use is not recommended. * @param options A set of key/value pairs that configure the default Ajax request. All options are optional. * @see \`{@link https://api.jquery.com/jQuery.ajaxSetup/ }\` * @since 1.1 * @example ​ ````Sets the defaults for Ajax requests to the url "/xmlhttp/", disables global handlers and uses POST instead of GET. The following Ajax requests then sends some data without having to set anything else. ```javascript $.ajaxSetup({ url: "/xmlhttp/", global: false, type: "POST" }); $.ajax({ data: myData }); ``` */ ajaxSetup(options: JQuery.AjaxSettings): JQuery.AjaxSettings; /** * Creates an object that handles the actual transmission of Ajax data. * @param dataType A string identifying the data type to use * @param handler A handler to return the new transport object to use with the data type provided in the first argument. * @see \`{@link https://api.jquery.com/jQuery.ajaxTransport/ }\` * @since 1.5 */ ajaxTransport(dataType: string, handler: (options: JQuery.AjaxSettings, originalOptions: JQuery.AjaxSettings, jqXHR: JQuery.jqXHR) => JQuery.Transport | void): void; /** * @deprecated ​ Deprecated since 3.3. Internal. See \`{@link https://github.com/jquery/jquery/issues/3384 }\`. */ camelCase(value: string): string; cleanData(elems: ArrayLike): void; /** * Check to see if a DOM element is a descendant of another DOM element. * @param container The DOM element that may contain the other element. * @param contained The DOM element that may be contained by (a descendant of) the other element. * @see \`{@link https://api.jquery.com/jQuery.contains/ }\` * @since 1.4 * @example ​ ````Check if an element is a descendant of another. ```javascript $.contains( document.documentElement, document.body ); // true $.contains( document.body, document.documentElement ); // false ``` */ contains(container: Element, contained: Element): boolean; css(elem: Element, name: string): any; /** * Store arbitrary data associated with the specified element. Returns the value that was set. * @param element The DOM element to associate with the data. * @param key A string naming the piece of data to set. * @param value The new data value; this can be any Javascript type except `undefined`. * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 * @example ​ ````Get the data named "blah" stored at for an element. ```html jQuery.data demo
      A div

      The "blah" value of this div is ?

      ​ ``` */ data(element: Element | Document | Window | JQuery.PlainObject, key: string, value: T): T; /** * Returns value at named data store for the element, as set by `jQuery.data(element, name, value)`, or the full data store for the element. * @param element The DOM element to query for the data. * @param key Name of the data stored. * @param value `undefined` is not recognized as a data value. Calls such as `jQuery.data( el, "name", undefined )` * will return the corresponding data for "name", and is therefore the same as `jQuery.data( el, "name" )` * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 */ // `unified-signatures` is disabled so that behavior when passing `undefined` to `value` can be documented. Unifying the signatures // results in potential confusion for users from an unexpected parameter. // tslint:disable-next-line:unified-signatures data(element: Element | Document | Window | JQuery.PlainObject, key: string, value: undefined): any; /** * Returns value at named data store for the element, as set by `jQuery.data(element, name, value)`, or the full data store for the element. * @param element The DOM element to query for the data. * @param key Name of the data stored. * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 * @since 1.4 * @example ​ ````Store then retrieve a value from the div element. ```html jQuery.data demo
      The values stored were and
      ​ ``` */ data(element: Element | Document | Window | JQuery.PlainObject, key?: string): any; /** * Execute the next function on the queue for the matched element. * @param element A DOM element from which to remove and execute a queued function. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @see \`{@link https://api.jquery.com/jQuery.dequeue/ }\` * @since 1.3 * @example ​ ````Use jQuery.dequeue() to end a custom queue function which allows the queue to keep going. ```html jQuery.dequeue demo
      ​ ``` */ dequeue(element: Element, queueName?: string): void; /** * A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties. * @param array The array to iterate over. * @param callback The function that will be executed on every object. * @see \`{@link https://api.jquery.com/jQuery.each/ }\` * @since 1.0 * @example ​ ````Iterates through the array displaying each number as both a word and numeral ```html jQuery.each demo
      ​ ``` * @example ​ ````Iterates over items in an array, accessing both the current item and its index. ```javascript $.each( [ "a", "b", "c" ], function( i, l ){ alert( "Index #" + i + ": " + l ); }); ``` */ each(array: ArrayLike, callback: (this: T, indexInArray: number, value: T) => any): ArrayLike; /** * A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties. * @param obj The object to iterate over. * @param callback The function that will be executed on every object. * @see \`{@link https://api.jquery.com/jQuery.each/ }\` * @since 1.0 * @example ​ ````Iterates through the array displaying each number as both a word and numeral ```html jQuery.each demo
      ​ ``` * @example ​ ````Iterates over the properties in an object, accessing both the current item and its key. ```javascript $.each({ name: "John", lang: "JS" }, function( k, v ) { alert( "Key: " + k + ", Value: " + v ); }); ``` */ each(obj: T, callback: (this: T[K], propertyName: K, valueOfProperty: T[K]) => any): T; /** * Takes a string and throws an exception containing it. * @param message The message to send out. * @see \`{@link https://api.jquery.com/jQuery.error/ }\` * @since 1.4.1 * @example ​ ````Override jQuery.error for display in Firebug. ```javascript jQuery.error = console.error; ``` */ error(message: string): any; /** * Escapes any character that has a special meaning in a CSS selector. * @param selector A string containing a selector expression to escape. * @see \`{@link https://api.jquery.com/jQuery.escapeSelector/ }\` * @since 3.0 * @example ​ ````Escape an ID containing a hash. ```javascript $.escapeSelector( "#target" ); // "\#target" ``` * @example ​ ````Select all the elements having a class name of .box inside a div. ```javascript $( "div" ).find( "." + $.escapeSelector( ".box" ) ); ``` */ escapeSelector(selector: JQuery.Selector): JQuery.Selector; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @param object5 An object containing additional properties to merge in. * @param object6 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X, object5: Y, object6: Z): T & U & V & W & X & Y & Z; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @param object5 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X, object5: Y): T & U & V & W & X & Y; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X): T & U & V & W & X; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U, object2: V, object3: W): T & U & V & W; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U, object2: V): T & U & V; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: T, object1: U): T & U; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T): this & T; /** * Merge the contents of two or more objects together into the first object. * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. * @param object1 An object containing additional properties to merge in. * @param objectN Additional objects containing properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 * @example ​ ````Merge two objects recursively, modifying the first. ```html jQuery.extend demo
      ​ ``` */ extend(deep: true, target: any, object1: any, ...objectN: any[]): any; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @param object5 An object containing additional properties to merge in. * @param object6 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U, object2: V, object3: W, object4: X, object5: Y, object6: Z): T & U & V & W & X & Y & Z; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @param object5 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U, object2: V, object3: W, object4: X, object5: Y): T & U & V & W & X & Y; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @param object4 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U, object2: V, object3: W, object4: X): T & U & V & W & X; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @param object3 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U, object2: V, object3: W): T & U & V & W; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param object2 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U, object2: V): T & U & V; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: T, object1: U): T & U; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T): this & T; /** * Merge the contents of two or more objects together into the first object. * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. * @param object1 An object containing additional properties to merge in. * @param objectN Additional objects containing properties to merge in. * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 * @example ​ ````Merge two objects, modifying the first. ```html jQuery.extend demo
      ​ ``` * @example ​ ````Merge defaults and options, without modifying the defaults. This is a common plugin development pattern. ```html jQuery.extend demo
      ​ ``` */ extend(target: any, object1: any, ...objectN: any[]): any; /** * Load data from the server using a HTTP GET request. * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param success A callback function that is executed if the request succeeds. Required if `dataType` is provided, * but you can use `null` or \`{@link noop jQuery.noop}\` as a placeholder. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 */ get(url: string, data: JQuery.PlainObject | string, success: JQuery.jqXHR.DoneCallback | null, dataType?: string): JQuery.jqXHR; /** * Load data from the server using a HTTP GET request. * @param url A string containing the URL to which the request is sent. * @param success A callback function that is executed if the request succeeds. Required if `dataType` is provided, * but you can use `null` or \`{@link noop jQuery.noop}\` as a placeholder. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 * @example ​ ````Get the test.php page contents, which has been returned in json format (<?php echo json_encode( array( "name"=>"John","time"=>"2pm" ) ); ?>), and add it to the page. ```javascript $.get( "test.php", function( data ) { $( "body" ) .append( "Name: " + data.name ) // John .append( "Time: " + data.time ); // 2pm }, "json" ); ``` */ get(url: string, success: JQuery.jqXHR.DoneCallback | null, dataType: string): JQuery.jqXHR; /** * Load data from the server using a HTTP GET request. * @param url A string containing the URL to which the request is sent. * @param success_data _@param_ `success_data` *
      * * `success` — A callback function that is executed if the request succeeds. Required if `dataType` is provided, * but you can use `null` or \`{@link noop jQuery.noop}\` as a placeholder.
      * * `data` — A plain object or string that is sent to the server with the request. * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 * @example ​ ````Request the test.php page and send some additional data along (while still ignoring the return results). ```javascript $.get( "test.php", { name: "John", time: "2pm" } ); ``` * @example ​ ````Pass arrays of data to the server (while still ignoring the return results). ```javascript $.get( "test.php", { "choices[]": ["Jon", "Susan"] } ); ``` * @example ​ ````Alert the results from requesting test.php (HTML or XML, depending on what was returned). ```javascript $.get( "test.php", function( data ) { alert( "Data Loaded: " + data ); }); ``` * @example ​ ````Alert the results from requesting test.cgi with an additional payload of data (HTML or XML, depending on what was returned). ```javascript $.get( "test.cgi", { name: "John", time: "2pm" } ) .done(function( data ) { alert( "Data Loaded: " + data ); }); ``` */ get(url: string, success_data: JQuery.jqXHR.DoneCallback | JQuery.PlainObject | string): JQuery.jqXHR; /** * Load data from the server using a HTTP GET request. * @param url_settings _@param_ `url_settings` *
      * * `url` — A string containing the URL to which the request is sent.
      * * `settings` — A set of key/value pairs that configure the Ajax request. All properties except for `url` are * optional. A default can be set for any option with \`{@link ajaxSetup $.ajaxSetup()}\`. See \`{@link https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings jQuery.ajax( settings )}\` * for a complete list of all settings. The type option will automatically be set to `GET`. * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 * @since 1.12 * @since 2.2 * @example ​ ````Request the test.php page, but ignore the return results. ```javascript $.get( "test.php" ); ``` */ get(url_settings?: string | JQuery.UrlAjaxSettings): JQuery.jqXHR; /** * Load JSON-encoded data from the server using a GET HTTP request. * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param success A callback function that is executed if the request succeeds. * @see \`{@link https://api.jquery.com/jQuery.getJSON/ }\` * @since 1.0 */ getJSON(url: string, data: JQuery.PlainObject | string, success: JQuery.jqXHR.DoneCallback): JQuery.jqXHR; /** * Load JSON-encoded data from the server using a GET HTTP request. * @param url A string containing the URL to which the request is sent. * @param success_data _@param_ `url_settings` *
      * * `success` — A callback function that is executed if the request succeeds.
      * * `data` — A plain object or string that is sent to the server with the request. * @see \`{@link https://api.jquery.com/jQuery.getJSON/ }\` * @since 1.0 * @example ​ ````Loads the four most recent pictures of Mount Rainier from the Flickr JSONP API. ```html jQuery.getJSON demo
      ​ ``` * @example ​ ````Load the JSON data from test.js and access a name from the returned JSON data. ```javascript $.getJSON( "test.js", function( json ) { console.log( "JSON Data: " + json.users[ 3 ].name ); }); ``` * @example ​ ````Load the JSON data from test.js, passing along additional data, and access a name from the returned JSON data. If an error occurs, log an error message instead. ```javascript $.getJSON( "test.js", { name: "John", time: "2pm" } ) .done(function( json ) { console.log( "JSON Data: " + json.users[ 3 ].name ); }) .fail(function( jqxhr, textStatus, error ) { var err = textStatus + ", " + error; console.log( "Request Failed: " + err ); }); ``` */ getJSON(url: string, success_data?: JQuery.jqXHR.DoneCallback | JQuery.PlainObject | string): JQuery.jqXHR; /** * Load a JavaScript file from the server using a GET HTTP request, then execute it. * @param url A string containing the URL to which the request is sent. * @param success A callback function that is executed if the request succeeds. * @see \`{@link https://api.jquery.com/jQuery.getScript/ }\` * @since 1.0 * @example ​ ````Define a $.cachedScript() method that allows fetching a cached script: ```javascript jQuery.cachedScript = function( url, options ) { ​ // Allow user to set any option except for dataType, cache, and url options = $.extend( options || {}, { dataType: "script", cache: true, url: url }); ​ // Use $.ajax() since it is more flexible than $.getScript // Return the jqXHR object so we can chain callbacks return jQuery.ajax( options ); }; ​ // Usage $.cachedScript( "ajax/test.js" ).done(function( script, textStatus ) { console.log( textStatus ); }); ``` * @example ​ ````Load the official jQuery Color Animation plugin dynamically and bind some color animations to occur once the new functionality is loaded. ```html jQuery.getScript demo
      ​ ``` */ getScript(url: string, success?: JQuery.jqXHR.DoneCallback): JQuery.jqXHR; /** * Load a JavaScript file from the server using a GET HTTP request, then execute it. * @see \`{@link https://api.jquery.com/jQuery.getScript/ }\` * @since 1.12 * @since 2.2 */ getScript(options: JQuery.UrlAjaxSettings): JQuery.jqXHR; /** * Execute some JavaScript code globally. * @param code The JavaScript code to execute. * @see \`{@link https://api.jquery.com/jQuery.globalEval/ }\` * @since 1.0.4 * @example ​ ````Execute a script in the global context. ```javascript function test() { jQuery.globalEval( "var newVar = true;" ) } test(); // newVar === true ``` */ globalEval(code: string): void; /** * Finds the elements of an array which satisfy a filter function. The original array is not affected. * @param array The array-like object to search through. * @param funсtion The function to process each item against. The first argument to the function is the item, and the * second argument is the index. The function should return a Boolean value. `this` will be the global * window object. * @param invert If "invert" is false, or not provided, then the function returns an array consisting of all elements * for which "callback" returns true. If "invert" is true, then the function returns an array * consisting of all elements for which "callback" returns false. * @see \`{@link https://api.jquery.com/jQuery.grep/ }\` * @since 1.0 * @example ​ ````Filters the original array of numbers leaving that are not 5 and have an index greater than 4. Then it removes all 9s. ```html jQuery.grep demo

      ​ ``` * @example ​ ````Filter an array of numbers to include only numbers bigger then zero. ```javascript $.grep( [ 0, 1, 2 ], function( n, i ) { return n > 0; }); ``` * @example ​ ````Filter an array of numbers to include numbers that are not bigger than zero. ```javascript $.grep( [ 0, 1, 2 ], function( n, i ) { return n > 0; }, true ); ``` */ grep(array: ArrayLike, funсtion: (elementOfArray: T, indexInArray: number) => boolean, invert?: boolean): T[]; /** * Determine whether an element has any jQuery data associated with it. * @param element A DOM element to be checked for data. * @see \`{@link https://api.jquery.com/jQuery.hasData/ }\` * @since 1.5 * @example ​ ````Set data on an element and see the results of hasData. ```html jQuery.hasData demo

      Results:

      ​ ``` */ hasData(element: Element | Document | Window | JQuery.PlainObject): boolean; /** * Holds or releases the execution of jQuery's ready event. * @param hold Indicates whether the ready hold is being requested or released * @see \`{@link https://api.jquery.com/jQuery.holdReady/ }\` * @since 1.6 * @deprecated ​ Deprecated since 3.2. See \`{@link https://github.com/jquery/jquery/issues/3288 }\`. * * **Cause**: The `jQuery.holdReady()` method has been deprecated due to its detrimental effect on the global performance of the page. This method can prevent all the code on the page from initializing for extended lengths of time. * * **Solution**: Rewrite the page so that it does not require all jQuery ready handlers to be delayed. This might be accomplished, for example, by late-loading only the code that requires the delay when it is safe to run. Due to the complexity of this method, jQuery Migrate does not attempt to fill the functionality. If the underlying version of jQuery used with jQuery Migrate no longer contains `jQuery.holdReady()` the code will fail shortly after this warning appears. * @example ​ ````Delay the ready event until a custom plugin has loaded. ```javascript $.holdReady( true ); $.getScript( "myplugin.js", function() { $.holdReady( false ); }); ``` */ holdReady(hold: boolean): void; /** * Modify and filter HTML strings passed through jQuery manipulation methods. * @param html The HTML string on which to operate. * @see \`{@link https://api.jquery.com/jQuery.htmlPrefilter/ }\` * @since 1.12 * @since 2.2 */ htmlPrefilter(html: JQuery.htmlString): JQuery.htmlString; /** * Search for a specified value within an array and return its index (or -1 if not found). * @param value The value to search for. * @param array An array through which to search. * @param fromIndex The index of the array at which to begin the search. The default is 0, which will search the whole array. * @see \`{@link https://api.jquery.com/jQuery.inArray/ }\` * @since 1.2 * @example ​ ````Report the index of some elements in the array. ```html jQuery.inArray demo
      "John" found at
      4 found at
      "Karl" not found, so
      "Pete" is in the array, but not at or after index 2, so
      ​ ``` */ inArray(value: T, array: T[], fromIndex?: number): number; /** * Determine whether the argument is an array. * @param obj Object to test whether or not it is an array. * @see \`{@link https://api.jquery.com/jQuery.isArray/ }\` * @since 1.3 * @deprecated ​ Deprecated since 3.2. Use \`{@link ArrayConstructor.isArray Array.isArray}\`. * @example ​ ````Finds out if the parameter is an array. ```html jQuery.isArray demo ​ Is [] an Array? ​ ``` */ isArray(obj: any): obj is any[]; /** * Check to see if an object is empty (contains no enumerable properties). * @param obj The object that will be checked to see if it's empty. * @see \`{@link https://api.jquery.com/jQuery.isEmptyObject/ }\` * @since 1.4 * @example ​ ````Check an object to see if it's empty. ```javascript jQuery.isEmptyObject({}); // true jQuery.isEmptyObject({ foo: "bar" }); // false ``` */ isEmptyObject(obj: any): boolean; /** * Determine if the argument passed is a JavaScript function object. * @param obj Object to test whether or not it is a function. * @see \`{@link https://api.jquery.com/jQuery.isFunction/ }\` * @since 1.2 * @deprecated ​ Deprecated since 3.3. Use `typeof x === "function"`. * @example ​ ````Test a few parameter examples. ```html jQuery.isFunction demo
      jQuery.isFunction( objs[ 0 ] ) =
      jQuery.isFunction( objs[ 1 ] ) =
      jQuery.isFunction( objs[ 2 ] ) =
      jQuery.isFunction( objs[ 3 ] ) =
      jQuery.isFunction( objs[ 4 ] ) =
      ​ ``` * @example ​ ````Finds out if the parameter is a function. ```javascript $.isFunction(function() {}); ``` */ // tslint:disable-next-line:ban-types isFunction(obj: any): obj is Function; /** * Determines whether its argument represents a JavaScript number. * @param value The value to be tested. * @see \`{@link https://api.jquery.com/jQuery.isNumeric/ }\` * @since 1.7 * @deprecated ​ Deprecated since 3.3. Internal. See \`{@link https://github.com/jquery/jquery/issues/2960 }\`. * @example ​ ````Sample return values of $.isNumeric with various inputs. ```javascript // true (numeric) $.isNumeric( "-10" ) $.isNumeric( "0" ) $.isNumeric( 0xFF ) $.isNumeric( "0xFF" ) $.isNumeric( "8e5" ) $.isNumeric( "3.1415" ) $.isNumeric( +10 ) $.isNumeric( 0144 ) ​ // false (non-numeric) $.isNumeric( "-0x42" ) $.isNumeric( "7.2acdgs" ) $.isNumeric( "" ) $.isNumeric( {} ) $.isNumeric( NaN ) $.isNumeric( null ) $.isNumeric( true ) $.isNumeric( Infinity ) $.isNumeric( undefined ) ``` */ isNumeric(value: any): boolean; /** * Check to see if an object is a plain object (created using "{}" or "new Object"). * @param obj The object that will be checked to see if it's a plain object. * @see \`{@link https://api.jquery.com/jQuery.isPlainObject/ }\` * @since 1.4 * @example ​ ````Check an object to see if it's a plain object. ```javascript jQuery.isPlainObject({}) // true jQuery.isPlainObject( "test" ) // false ``` */ isPlainObject(obj: any): boolean; /** * Determine whether the argument is a window. * @param obj Object to test whether or not it is a window. * @see \`{@link https://api.jquery.com/jQuery.isWindow/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Internal. See \`{@link https://github.com/jquery/jquery/issues/3629 }\`. * * **Cause**: This method returns `true` if its argument is thought to be a `window` element. It was created for internal use and is not a reliable way of detecting `window` for public needs. * * **Solution**: Remove any use of `jQuery.isWindow()` from code. If it is truly needed it can be replaced with a check for `obj != null && obj === obj.window` which was the test used inside this method. * @example ​ ````Finds out if the parameter is a window. ```html jQuery.isWindow demo ​ Is 'window' a window? ​ ``` */ isWindow(obj: any): obj is Window; /** * Check to see if a DOM node is within an XML document (or is an XML document). * @param node The DOM node that will be checked to see if it's in an XML document. * @see \`{@link https://api.jquery.com/jQuery.isXMLDoc/ }\` * @since 1.1.4 * @example ​ ````Check an object to see if it's in an XML document. ```javascript jQuery.isXMLDoc( document ) // false jQuery.isXMLDoc( document.body ) // false ``` */ isXMLDoc(node: Node): boolean; /** * Convert an array-like object into a true JavaScript array. * @param obj Any object to turn into a native Array. * @see \`{@link https://api.jquery.com/jQuery.makeArray/ }\` * @since 1.2 * @example ​ ````Turn a collection of HTMLElements into an Array of them. ```html jQuery.makeArray demo
      First
      Second
      Third
      Fourth
      ​ ``` * @example ​ ````Turn a jQuery object into an array ```javascript var obj = $( "li" ); var arr = $.makeArray( obj ); ``` */ makeArray(obj: ArrayLike): T[]; /** * Translate all items in an array or object to new array of items. * @param array The Array to translate. * @param callback The function to process each item against. The first argument to the function is the array item, the * second argument is the index in array The function can return any value. A returned array will be * flattened into the resulting array. Within the function, this refers to the global (window) object. * @see \`{@link https://api.jquery.com/jQuery.map/ }\` * @since 1.0 * @example ​ ````Use $.map() to change the values of an array. ```html jQuery.map demo

      ​ ``` * @example ​ ````Map the original array to a new one and add 4 to each value. ```javascript $.map( [ 0, 1, 2 ], function( n ) { return n + 4; }); ``` * @example ​ ````Map the original array to a new one, adding 1 to each value if it is bigger then zero and removing it if not. ```javascript $.map( [ 0, 1, 2 ], function( n ) { return n > 0 ? n + 1 : null; }); ``` * @example ​ ````Map the original array to a new one; each element is added with its original value and the value plus one. ```javascript $.map( [ 0, 1, 2 ], function( n ) { return [ n, n + 1 ]; }); ``` * @example ​ ````Map the original array to a new one; each element is squared. ```javascript $.map( [ 0, 1, 2, 3 ], function( a ) { return a * a; }); ``` * @example ​ ````Map the original array to a new one, removing numbers less than 50 by returning null and subtracting 45 from the rest. ```javascript $.map( [ 0, 1, 52, 97 ], function( a ) { return (a > 50 ? a - 45 : null); }); ``` * @example ​ ````Augment the resulting array by returning an array inside the function. ```javascript var array = [ 0, 1, 52, 97 ]; array = $.map( array, function( a, index ) { return [ a - 45, index ]; }); ``` */ map(array: T[], callback: (this: Window, elementOfArray: T, indexInArray: number) => JQuery.TypeOrArray | null | undefined): TReturn[]; /** * Translate all items in an array or object to new array of items. * @param obj The Object to translate. * @param callback The function to process each item against. The first argument to the function is the value; the * second argument is the key of the object property. The function can return any value to add to the * array. A returned array will be flattened into the resulting array. Within the function, this refers * to the global (window) object. * @see \`{@link https://api.jquery.com/jQuery.map/ }\` * @since 1.6 * @example ​ ````Map the original object to a new array and double each value. ```javascript var dimensions = { width: 10, height: 15, length: 20 }; dimensions = $.map( dimensions, function( value, index ) { return value * 2; }); ``` * @example ​ ````Map an object's keys to an array. ```javascript var dimensions = { width: 10, height: 15, length: 20 }; var keys = $.map( dimensions, function( value, key ) { return key; }); ``` */ map(obj: T, callback: (this: Window, propertyOfObject: T[K], key: K) => JQuery.TypeOrArray | null | undefined): TReturn[]; /** * Merge the contents of two arrays together into the first array. * @param first The first array-like object to merge, the elements of second added. * @param second The second array-like object to merge into the first, unaltered. * @see \`{@link https://api.jquery.com/jQuery.merge/ }\` * @since 1.0 * @example ​ ````Merges two arrays, altering the first argument. ```javascript $.merge( [ 0, 1, 2 ], [ 2, 3, 4 ] ) ``` * @example ​ ````Merges two arrays, altering the first argument. ```javascript $.merge( [ 3, 2, 1 ], [ 4, 3, 2 ] ) ``` * @example ​ ````Merges two arrays, but uses a copy, so the original isn't altered. ```javascript var first = [ "a", "b", "c" ]; var second = [ "d", "e", "f" ]; $.merge( $.merge( [], first ), second ); ``` */ merge(first: ArrayLike, second: ArrayLike): Array; /** * Relinquish jQuery's control of the $ variable. * @param removeAll A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself). * @see \`{@link https://api.jquery.com/jQuery.noConflict/ }\` * @since 1.0 * @example ​ ````Map the original object that was referenced by $ back to $. ```javascript jQuery.noConflict(); // Do something with jQuery jQuery( "div p" ).hide(); // Do something with another library's $() $( "content" ).style.display = "none"; ``` * @example ​ ````Revert the $ alias and then create and execute a function to provide the $ as a jQuery alias inside the function's scope. Inside the function the original $ object is not available. This works well for most plugins that don't rely on any other library. ```javascript jQuery.noConflict(); (function( $ ) { $(function() { // More code using $ as alias to jQuery }); })(jQuery); ​ // Other code using $ as an alias to the other library ``` * @example ​ ````Create a different alias instead of jQuery to use in the rest of the script. ```javascript var j = jQuery.noConflict(); ​ // Do something with jQuery j( "div p" ).hide(); ​ // Do something with another library's $() $( "content" ).style.display = "none"; ``` * @example ​ ````Completely move jQuery to a new namespace in another object. ```javascript var dom = {}; dom.query = jQuery.noConflict( true ); ``` * @example ​ ````Load two versions of jQuery (not recommended). Then, restore jQuery's globally scoped variables to the first loaded jQuery. ```html jQuery.noConflict demo

      Before $.noConflict(true)

      ​ ``` */ noConflict(removeAll?: boolean): this; /** * @deprecated ​ Deprecated since 3.2. * * **Cause**: This public but never-documented method has been deprecated as of jQuery 3.2.0. * * **Solution**: Replace calls such as `jQuery.nodeName( elem, "div" )` with a test such as `elem.nodeName.toLowerCase() === "div"`. */ nodeName(elem: Node, name: string): boolean; /** * An empty function. * @see \`{@link https://api.jquery.com/jQuery.noop/ }\` * @since 1.4 */ noop(): undefined; /** * Return a number representing the current time. * @see \`{@link https://api.jquery.com/jQuery.now/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.3. Use \`{@link DateConstructor.now Date.now}\`. */ now(): number; /** * Create a serialized representation of an array, a plain object, or a jQuery object suitable for use in a URL query string or Ajax request. In case a jQuery object is passed, it should contain input elements with name/value properties. * @param obj An array, a plain object, or a jQuery object to serialize. * @param traditional A Boolean indicating whether to perform a traditional "shallow" serialization. * @see \`{@link https://api.jquery.com/jQuery.param/ }\` * @since 1.2 * @since 1.4 * @example ​ ````Serialize a key/value object. ```html jQuery.param demo
      ​ ``` * @example ​ ````Serialize a few complex objects ```html jQuery.param demo ​​ ​ ``` */ param(obj: any[] | JQuery.PlainObject | JQuery, traditional?: boolean): string; /** * Parses a string into an array of DOM nodes. * @param data HTML string to be parsed * @param context Document element to serve as the context in which the HTML fragment will be created * @param keepScripts A Boolean indicating whether to include scripts passed in the HTML string * @see \`{@link https://api.jquery.com/jQuery.parseHTML/ }\` * @since 1.8 */ parseHTML(data: string, context: Document | null | undefined, keepScripts: boolean): JQuery.Node[]; /** * Parses a string into an array of DOM nodes. * @param data HTML string to be parsed * @param context_keepScripts _@param_ `context_keepScripts` *
      * * `context` — Document element to serve as the context in which the HTML fragment will be created
      * * `keepScripts` — A Boolean indicating whether to include scripts passed in the HTML string * @see \`{@link https://api.jquery.com/jQuery.parseHTML/ }\` * @since 1.8 * @example ​ ````Create an array of DOM nodes using an HTML string and insert it into a div. ```html jQuery.parseHTML demo

      Content:

      ​ ``` */ parseHTML(data: string, context_keepScripts?: Document | null | boolean): JQuery.Node[]; /** * Takes a well-formed JSON string and returns the resulting JavaScript value. * @param json The JSON string to parse. * @see \`{@link https://api.jquery.com/jQuery.parseJSON/ }\` * @since 1.4.1 * @deprecated ​ Deprecated since 3.0. Use \`{@link JSON.parse }\`. * * **Cause**: The `jQuery.parseJSON` method in recent jQuery is identical to the native `JSON.parse`. As of jQuery 3.0 `jQuery.parseJSON` is deprecated. * * **Solution**: Replace any use of `jQuery.parseJSON` with `JSON.parse`. * @example ​ ````Parse a JSON string. ```javascript var obj = jQuery.parseJSON( '{ "name": "John" }' ); alert( obj.name === "John" ); ``` */ parseJSON(json: string): any; /** * Parses a string into an XML document. * @param data a well-formed XML string to be parsed * @see \`{@link https://api.jquery.com/jQuery.parseXML/ }\` * @since 1.5 * @example ​ ````Create a jQuery object using an XML string and obtain the value of the title node. ```html jQuery.parseXML demo

      ​ ``` */ parseXML(data: string): XMLDocument; /** * Load data from the server using a HTTP POST request. * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * can be null in that case. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 * @example ​ ````Post to the test.php page and get content which has been returned in json format (<?php echo json_encode(array("name"=>"John","time"=>"2pm")); ?>). ```javascript $.post( "test.php", { func: "getNameAndTime" }, function( data ) { console.log( data.name ); // John console.log( data.time ); // 2pm }, "json"); ``` */ post(url: string, data: JQuery.PlainObject | string, success: JQuery.jqXHR.DoneCallback | null, dataType?: string): JQuery.jqXHR; /** * Load data from the server using a HTTP POST request. * @param url A string containing the URL to which the request is sent. * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * can be null in that case. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 */ post(url: string, success: JQuery.jqXHR.DoneCallback | null, dataType: string): JQuery.jqXHR; /** * Load data from the server using a HTTP POST request. * @param url A string containing the URL to which the request is sent. * @param success_data _@param_ `success_data` *
      * * `success` — A callback function that is executed if the request succeeds. Required if `dataType` is provided, * but can be `null` in that case.
      * * `data` — A plain object or string that is sent to the server with the request. * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 * @example ​ ````Request the test.php page and send some additional data along (while still ignoring the return results). ```javascript $.post( "test.php", { name: "John", time: "2pm" } ); ``` * @example ​ ````Pass arrays of data to the server (while still ignoring the return results). ```javascript $.post( "test.php", { 'choices[]': [ "Jon", "Susan" ] } ); ``` * @example ​ ````Send form data using Ajax requests ```javascript $.post( "test.php", $( "#testform" ).serialize() ); ``` * @example ​ ````Alert the results from requesting test.php (HTML or XML, depending on what was returned). ```javascript $.post( "test.php", function( data ) { alert( "Data Loaded: " + data ); }); ``` * @example ​ ````Alert the results from requesting test.php with an additional payload of data (HTML or XML, depending on what was returned). ```javascript $.post( "test.php", { name: "John", time: "2pm" }) .done(function( data ) { alert( "Data Loaded: " + data ); }); ``` * @example ​ ````Post a form using Ajax and put results in a div ```html jQuery.post demo
      ​ ``` */ post(url: string, success_data: JQuery.jqXHR.DoneCallback | JQuery.PlainObject | string): JQuery.jqXHR; /** * Load data from the server using a HTTP POST request. * @param url_settings _@param_ `url_settings` *
      * * `url` — A string containing the URL to which the request is sent.
      * * `settings` — A set of key/value pairs that configure the Ajax request. All properties except for `url` are optional. * A default can be set for any option with \`{@link ajaxSetup $.ajaxSetup()}\`. See \`{@link https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings jQuery.ajax( settings )}\` * for a complete list of all settings. Type will automatically be set to `POST`. * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 * @since 1.12 * @since 2.2 * @example ​ ````Request the test.php page, but ignore the return results. ```javascript $.post( "test.php" ); ``` */ post(url_settings?: string | JQuery.UrlAjaxSettings): JQuery.jqXHR; // region proxy // #region proxy // region (funсtion, null | undefined) // #region (funсtion, null | undefined) // region 0 to 7 additional arguments // #region 0 to 7 additional arguments // region 0 parameters // #region 0 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C) => TReturn, context: null | undefined, a: A, b: B, c: C): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B) => TReturn, context: null | undefined, a: A, b: B): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A) => TReturn, context: null | undefined, a: A): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: () => TReturn, context: null | undefined): () => TReturn; // #endregion // region 1 parameters // #region 1 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T) => TReturn, context: null | undefined, a: A, b: B): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T) => TReturn, context: null | undefined, a: A): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T) => TReturn, context: null | undefined): (t: T) => TReturn; // #endregion // region 2 parameters // #region 2 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U) => TReturn, context: null | undefined, a: A): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U) => TReturn, context: null | undefined): (t: T, u: U) => TReturn; // #endregion // region 3 parameters // #region 3 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U, v: V) => TReturn, context: null | undefined, a: A): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U, v: V) => TReturn, context: null | undefined): (t: T, u: U, v: V) => TReturn; // #endregion // region 4 parameters // #region 4 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U, v: V, w: W) => TReturn, context: null | undefined, a: A): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U, v: V, w: W) => TReturn, context: null | undefined): (t: T, u: U, v: V, w: W) => TReturn; // #endregion // region 5 parameters // #region 5 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined, a: A): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U, v: V, w: W, x: X) => TReturn, context: null | undefined): (t: T, u: U, v: V, w: W, x: X) => TReturn; // #endregion // region 6 parameters // #region 6 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined, a: A): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: null | undefined): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; // #endregion // region 7+ parameters // #region 7+ parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, b: B, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A, b: B): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (a: A, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined, a: A): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: null | undefined): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; // #endregion // #endregion // region 8+ additional arguments // #region 8+ additional arguments /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param additionalArguments Any number of arguments to be passed to the function referenced in the function argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. */ proxy(funсtion: (...args: any[]) => TReturn, context: null | undefined, ...additionalArguments: any[]): (...args: any[]) => TReturn; // #endregion // #endregion // region (funсtion, context) // #region (funсtion, context) // region 0 to 7 additional arguments // #region 0 to 7 additional arguments // region 0 parameters // #region 0 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D) => TReturn, context: TContext, a: A, b: B, c: C, d: D): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C) => TReturn, context: TContext, a: A, b: B, c: C): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B) => TReturn, context: TContext, a: A, b: B): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4` * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A) => TReturn, context: TContext, a: A): () => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext) => TReturn, context: TContext): () => TReturn; // #endregion // region 1 parameters // #region 1 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T) => TReturn, context: TContext, a: A, b: B, c: C): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T) => TReturn, context: TContext, a: A, b: B): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T) => TReturn, context: TContext, a: A): (t: T) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T) => TReturn, context: TContext): (t: T) => TReturn; // #endregion // region 2 parameters // #region 2 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U) => TReturn, context: TContext, a: A, b: B): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U) => TReturn, context: TContext, a: A): (t: T, u: U) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U) => TReturn, context: TContext): (t: T, u: U) => TReturn; // #endregion // region 3 parameters // #region 3 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U, v: V) => TReturn, context: TContext, a: A, b: B): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U, v: V) => TReturn, context: TContext, a: A): (t: T, u: U, v: V) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U, v: V) => TReturn, context: TContext): (t: T, u: U, v: V) => TReturn; // #endregion // region 4 parameters // #region 4 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A, b: B): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U, v: V, w: W) => TReturn, context: TContext, a: A): (t: T, u: U, v: V, w: W) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U, v: V, w: W) => TReturn, context: TContext): (t: T, u: U, v: V, w: W) => TReturn; // #endregion // region 5 parameters // #region 5 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A, b: B): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext, a: A): (t: T, u: U, v: V, w: W, x: X) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U, v: V, w: W, x: X) => TReturn, context: TContext): (t: T, u: U, v: V, w: W, x: X) => TReturn; // #endregion // region 6 parameters // #region 6 parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A, b: B): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext, a: A): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn, context: TContext): (t: T, u: U, v: V, w: W, x: X, y: Y) => TReturn; // #endregion // region 7+ parameters // #region 7+ parameters /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @param g An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F, g: G): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @param f An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, f: F, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E, f: F): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @param e An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, e: E, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B, c: C, d: D, e: E): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @param d An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, d: D, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B, c: C, d: D): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @param c An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, c: C, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B, c: C): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @param b An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, b: B, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A, b: B): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param a An argument to be passed to the function referenced in the `function` argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, a: A, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext, a: A): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn, context: TContext): (t: T, u: U, v: V, w: W, x: X, y: Y, z: Z, ...args: any[]) => TReturn; // #endregion // #endregion // region 8+ additional arguments // #region 8+ additional arguments /** * Takes a function and returns a new one that will always have a particular context. * @param funсtion The function whose context will be changed. * @param context The object to which the context (`this`) of the function should be set. * @param additionalArguments Any number of arguments to be passed to the function referenced in the function argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Change the context of functions bound to a click handler using the "function, context" signature. Unbind the first handler after first click. ```html jQuery.proxy demo

      ​ ``` * @example ​ ````Change the context of a function bound to the click handler, ```html jQuery.proxy demo

      ​ ``` */ proxy(funсtion: (this: TContext, ...args: any[]) => TReturn, context: TContext, ...additionalArguments: any[]): (...args: any[]) => TReturn; // #endregion // #endregion // region (context, name) // #region (context, name) /** * Takes a function and returns a new one that will always have a particular context. * @param context The object to which the context of the function should be set. * @param name The name of the function whose context will be changed (should be a property of the context object). * @param additionalArguments Any number of arguments to be passed to the function named in the name argument. * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated ​ Deprecated since 3.3. Use \`{@link Function#bind }\`. * @example ​ ````Enforce the context of the function using the "context, function name" signature. Unbind the handler after first click. ```html jQuery.proxy demo

      ​ ``` */ proxy(context: TContext, name: keyof TContext, ...additionalArguments: any[]): (...args: any[]) => any; // #endregion // #endregion /** * Manipulate the queue of functions to be executed on the matched element. * @param element A DOM element where the array of queued functions is attached. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @param newQueue The new function to add to the queue. * An array of functions to replace the current queue contents. * @see \`{@link https://api.jquery.com/jQuery.queue/ }\` * @since 1.3 * @example ​ ````Show the length of the queue. ```html jQuery.queue demo
      ​ ``` * @example ​ ````Queue a custom function. ```html jQuery.queue demo ​ Click here...
      ​ ``` * @example ​ ````Set a queue array to delete the queue. ```html jQuery.queue demo
      ​ ``` */ queue(element: T, queueName?: string, newQueue?: JQuery.TypeOrArray>): JQuery.Queue; /** * Handles errors thrown synchronously in functions wrapped in jQuery(). * @param error An error thrown in the function wrapped in jQuery(). * @see \`{@link https://api.jquery.com/jQuery.readyException/ }\` * @since 3.1 * @example ​ ````Pass the received error to console.error. ```javascript jQuery.readyException = function( error ) { console.error( error ); }; ``` */ readyException(error: Error): any; /** * Remove a previously-stored piece of data. * @param element A DOM element from which to remove data. * @param name A string naming the piece of data to remove. * @see \`{@link https://api.jquery.com/jQuery.removeData/ }\` * @since 1.2.3 * @example ​ ````Set a data store for 2 names then remove one of them. ```html jQuery.removeData demo
      value1 before creation:
      value1 after creation:
      value1 after removal:
      value2 after removal:
      ​ ``` */ removeData(element: Element | Document | Window | JQuery.PlainObject, name?: string): void; /** * Creates an object containing a set of properties ready to be used in the definition of custom animations. * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.1 */ speed(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): JQuery.EffectsOptions; /** * Creates an object containing a set of properties ready to be used in the definition of custom animations. * @param duration A string or number determining how long the animation will run. * @param easing_complete _@param_ `easing_complete` *
      * * `easing` — A string indicating which easing function to use for the transition.
      * * `complete` — A function to call once the animation is complete, called once per matched element. * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.0 * @since 1.1 */ speed(duration: JQuery.Duration, easing_complete: string | ((this: TElement) => void)): JQuery.EffectsOptions; /** * Creates an object containing a set of properties ready to be used in the definition of custom animations. * @param duration_complete_settings _@param_ `duration_complete_settings` *
      * * `duration` — A string or number determining how long the animation will run.
      * * `complete` — A function to call once the animation is complete, called once per matched element.
      * * `settings` — * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.0 * @since 1.1 */ speed(duration_complete_settings?: JQuery.Duration | ((this: TElement) => void) | JQuery.SpeedSettings): JQuery.EffectsOptions; /** * Remove the whitespace from the beginning and end of a string. * @param str The string to trim. * @see \`{@link https://api.jquery.com/jQuery.trim/ }\` * @since 1.0 * @example ​ ````Remove the white spaces at the start and at the end of the string. ```html jQuery.trim demo
      
      
      
      ​
      
      
      ```
           * @example ​ ````Remove the white spaces at the start and at the end of the string.
      ```javascript
      $.trim("    hello, how are you?    ");
      ```
           * @example ​ ````Remove the white spaces at the start and at the end of the string.
      ```javascript
      $.trim("    hello, how are you?    ");
      ```
           */
          trim(str: string): string;
          /**
           * Determine the internal JavaScript [[Class]] of an object.
           * @param obj Object to get the internal JavaScript [[Class]] of.
           * @see \`{@link https://api.jquery.com/jQuery.type/ }\`
           * @since 1.4.3
           * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/jquery/issues/3605 }\`.
           * @example ​ ````Find out if the parameter is a RegExp.
      ```html
      
      
      
        
        jQuery.type demo
        
      
      
      ​
      Is it a RegExp? 
      ​
      
      
      ```
           */
          type(obj: any): 'array' | 'boolean' | 'date' | 'error' | 'function' | 'null' | 'number' | 'object' | 'regexp' | 'string' | 'symbol' | 'undefined';
          /**
           * Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.
           * @param array The Array of DOM elements.
           * @see \`{@link https://api.jquery.com/jQuery.unique/ }\`
           * @since 1.1.3
           * @deprecated ​ Deprecated since 3.0. Use \`{@link uniqueSort }\`.
           *
           * **Cause**: The fact that `jQuery.unique` sorted its results in DOM order was surprising to many who did not read the documentation carefully. As of jQuery 3.0 this function is being renamed to make it clear.
           *
           * **Solution**: Replace all uses of `jQuery.unique` with `jQuery.uniqueSort` which is the same function with a better name.
           * @example ​ ````Removes any duplicate elements from the array of divs.
      ```html
      
      
      
        
        jQuery.unique demo
        
        
      There are 6 divs in this document.
      ​ ``` */ unique(array: T[]): T[]; /** * Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers. * @param array The Array of DOM elements. * @see \`{@link https://api.jquery.com/jQuery.uniqueSort/ }\` * @since 1.12 * @since 2.2 * @example ​ ````Removes any duplicate elements from the array of divs. ```html jQuery.uniqueSort demo
      There are 6 divs in this document.
      ​ ``` */ uniqueSort(array: T[]): T[]; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when( deferredT: JQuery.Promise | JQuery.Thenable | TR1, deferredU: JQuery.Promise | JQuery.Thenable | UR1, deferredV: JQuery.Promise | JQuery.Thenable | VR1, ): JQuery.Promise3< TR1, TJ1, never, UR1, UJ1, never, VR1, VJ1, never>; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when( deferredT: JQuery.Promise | JQuery.Thenable | TR1, deferredU: JQuery.Promise | JQuery.Thenable | UR1, ): JQuery.Promise2< TR1, TJ1, never, UR1, UJ1, never>; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when( deferredT: JQuery.Promise3 | JQuery.Promise2 ): JQuery.Promise3< TR1, TJ1, never, TR2, TJ2, never, TR3, TJ3, never>; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when(deferred: JQuery.Promise | JQuery.Thenable | TR1): JQuery.Promise; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @param deferreds Zero or more Thenable objects. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when(...deferreds: Array | JQuery.Thenable | TR1>): JQuery.Promise; /** * Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events. * @param deferreds Zero or more Thenable objects. * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 * @example ​ ````Execute a function after two Ajax requests are successful. (See the jQuery.ajax() documentation for a complete description of success and error cases for an ajax request). ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ).done(function( a1, a2 ) { // a1 and a2 are arguments resolved for the page1 and page2 ajax requests, respectively. // Each argument is an array with the following structure: [ data, statusText, jqXHR ] var data = a1[ 0 ] + a2[ 0 ]; // a1[ 0 ] = "Whip", a2[ 0 ] = " It" if ( /Whip It/.test( data ) ) { alert( "We got what we came for!" ); } }); ``` * @example ​ ````Execute the function myFunc when both ajax requests are successful, or myFailure if either one has an error. ```javascript $.when( $.ajax( "/page1.php" ), $.ajax( "/page2.php" ) ) .then( myFunc, myFailure ); ``` */ when(...deferreds: any[]): JQuery.Promise; } // tslint:disable:jsdoc-format // tslint:disable:max-line-length // tslint:disable:no-irregular-whitespace declare namespace JQuery { type TypeOrArray = T | T[]; type Node = Element | Text | Comment | Document | DocumentFragment; /** * A string is designated htmlString in jQuery documentation when it is used to represent one or more DOM elements, typically to be created and inserted in the document. When passed as an argument of the jQuery() function, the string is identified as HTML if it starts with ) and is parsed as such until the final > character. Prior to jQuery 1.9, a string was considered to be HTML if it contained anywhere within the string. */ type htmlString = string; /** * A selector is used in jQuery to select DOM elements from a DOM document. That document is, in most cases, the DOM document present in all browsers, but can also be an XML document received via Ajax. */ type Selector = string; /** * The PlainObject type is a JavaScript object containing zero or more key-value pairs. The plain object is, in other words, an Object object. It is designated "plain" in jQuery documentation to distinguish it from other kinds of JavaScript objects: for example, null, user-defined arrays, and host objects such as document, all of which have a typeof value of "object." * * **Note**: The type declaration of PlainObject is imprecise. It includes host objects and user-defined arrays which do not match jQuery's definition. */ interface PlainObject { [key: string]: T; } interface Selectors extends Sizzle.Selectors { /** * @deprecated ​ Deprecated since 3.0. Use \`{@link Selectors#pseudos }\`. * * **Cause**: The standard way to add new custom selectors through jQuery is `jQuery.expr.pseudos`. These two other aliases are deprecated, although they still work as of jQuery 3.0. * * **Solution**: Rename any of the older usage to `jQuery.expr.pseudos`. The functionality is identical. */ ':': Sizzle.Selectors.PseudoFunctions; /** * @deprecated ​ Deprecated since 3.0. Use \`{@link Selectors#pseudos }\`. * * **Cause**: The standard way to add new custom selectors through jQuery is `jQuery.expr.pseudos`. These two other aliases are deprecated, although they still work as of jQuery 3.0. * * **Solution**: Rename any of the older usage to `jQuery.expr.pseudos`. The functionality is identical. */ filter: Sizzle.Selectors.FilterFunctions; } // region Ajax // #region Ajax interface AjaxSettings extends Ajax.AjaxSettingsBase { /** * A string containing the URL to which the request is sent. */ url?: string; } interface UrlAjaxSettings extends Ajax.AjaxSettingsBase { /** * A string containing the URL to which the request is sent. */ url: string; } namespace Ajax { type SuccessTextStatus = 'success' | 'notmodified' | 'nocontent'; type ErrorTextStatus = 'timeout' | 'error' | 'abort' | 'parsererror'; type TextStatus = SuccessTextStatus | ErrorTextStatus; type SuccessCallback = (this: TContext, data: any, textStatus: SuccessTextStatus, jqXHR: jqXHR) => void; type ErrorCallback = (this: TContext, jqXHR: jqXHR, textStatus: ErrorTextStatus, errorThrown: string) => void; type CompleteCallback = (this: TContext, jqXHR: jqXHR, textStatus: TextStatus) => void; /** * @see \`{@link https://api.jquery.com/jquery.ajax/#jQuery-ajax-settings }\` */ interface AjaxSettingsBase { /** * A set of key/value pairs that map a given dataType to its MIME type, which gets sent in the Accept request header. This header tells the server what kind of response it will accept in return. */ accepts?: PlainObject; /** * By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Cross-domain requests and dataType: "jsonp" requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active. As of jQuery 1.8, the use of async: false with jqXHR ($.Deferred) is deprecated; you must use the success/error/complete callback options instead of the corresponding methods of the jqXHR object such as jqXHR.done(). */ async?: boolean; /** * A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings objects are passed as arguments. This is an Ajax Event. Returning false in the beforeSend function will cancel the request. As of jQuery 1.5, the beforeSend option will be called regardless of the type of request. */ beforeSend?(this: TContext, jqXHR: jqXHR, settings: this): false | void; /** * If set to false, it will force requested pages not to be cached by the browser. Note: Setting cache to false will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}" to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a POST is made to a URL that has already been requested by a GET. */ cache?: boolean; /** * A function to be called when the request finishes (after success and error callbacks are executed). The function gets passed two arguments: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request ("success", "notmodified", "nocontent", "error", "timeout", "abort", or "parsererror"). As of jQuery 1.5, the complete setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event. */ complete?: TypeOrArray>; /** * An object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type. */ contents?: PlainObject; /** * When sending data to the server, use this content type. Default is "application/x-www-form-urlencoded; charset=UTF-8", which is fine for most cases. If you explicitly pass in a content-type to $.ajax(), then it is always sent to the server (even if no data is sent). As of jQuery 1.6 you can pass false to tell jQuery to not set any content type header. Note: The W3C XMLHttpRequest specification dictates that the charset is always UTF-8; specifying another charset will not force the browser to change the encoding. Note: For cross-domain requests, setting the content type to anything other than application/x-www-form-urlencoded, multipart/form-data, or text/plain will trigger the browser to send a preflight OPTIONS request to the server. */ contentType?: string | false; /** * This object will be the context of all Ajax-related callbacks. By default, the context is an object that represents the Ajax settings used in the call ($.ajaxSettings merged with the settings passed to $.ajax). */ context?: TContext; /** * An object containing dataType-to-dataType converters. Each converter's value is a function that returns the transformed value of the response. */ converters?: PlainObject<((value: any) => any) | true>; /** * If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain. */ crossDomain?: boolean; /** * Data to be sent to the server. It is converted to a query string, if not already a string. It's appended to the url for GET-requests. See processData option to prevent this automatic processing. Object must be Key/Value pairs. If value is an Array, jQuery serializes multiple values with same key based on the value of the traditional setting (described below). */ data?: PlainObject | string; /** * A function to be used to handle the raw response data of XMLHttpRequest. This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two arguments: The raw data returned from the server and the 'dataType' parameter. */ dataFilter?(data: string, type: string): any; /** * The type of data that you're expecting back from the server. If none is specified, jQuery will try to infer it based on the MIME type of the response (an XML MIME type will yield XML, in 1.4 JSON will yield a JavaScript object, in 1.4 script will execute the script, and anything else will be returned as a string). The available types (and the result passed as the first argument to your success callback) are: * * "xml": Returns a XML document that can be processed via jQuery. * * "html": Returns HTML as plain text; included script tags are evaluated when inserted in the DOM. * * "script": Evaluates the response as JavaScript and returns it as plain text. Disables caching by appending a query string parameter, _=[TIMESTAMP], to the URL unless the cache option is set to true. Note: This will turn POSTs into GETs for remote-domain requests. * * "json": Evaluates the response as JSON and returns a JavaScript object. Cross-domain "json" requests are converted to "jsonp" unless the request includes jsonp: false in its request options. The JSON data is parsed in a strict manner; any malformed JSON is rejected and a parse error is thrown. As of jQuery 1.9, an empty response is also rejected; the server should return a response of null or {} instead. (See json.org for more information on proper JSON formatting.) * * "jsonp": Loads in a JSON block using JSONP. Adds an extra "?callback=?" to the end of your URL to specify the callback. Disables caching by appending a query string parameter, "_=[TIMESTAMP]", to the URL unless the cache option is set to true. * * "text": A plain text string. * * multiple, space-separated values: As of jQuery 1.5, jQuery can convert a dataType from what it received in the Content-Type header to what you require. For example, if you want a text response to be treated as XML, use "text xml" for the dataType. You can also make a JSONP request, have it received as text, and interpreted by jQuery as XML: "jsonp text xml". Similarly, a shorthand string such as "jsonp xml" will first attempt to convert from jsonp to xml, and, failing that, convert from jsonp to text, and then from text to xml. */ dataType?: 'xml' | 'html' | 'script' | 'json' | 'jsonp' | 'text' | string; /** * The MIME type of content that is used to submit the form to the server. Possible values are: * * "application/x-www-form-urlencoded": The initial default type. * * "multipart/form-data": The type that allows file element(s) to upload file data. * * "text/plain": A type introduced in HTML5. */ enctype?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'; /** * A function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides null) are "timeout", "error", "abort", and "parsererror". When an HTTP error occurs, errorThrown receives the textual portion of the HTTP status, such as "Not Found" or "Internal Server Error." As of jQuery 1.5, the error setting can accept an array of functions. Each function will be called in turn. Note: This handler is not called for cross-domain script and cross-domain JSONP requests. This is an Ajax Event. */ error?: TypeOrArray>; /** * Whether to trigger global Ajax event handlers for this request. The default is true. Set to false to prevent the global handlers like ajaxStart or ajaxStop from being triggered. This can be used to control various Ajax Events. */ global?: boolean; /** * An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport. The header X-Requested-With: XMLHttpRequest is always added, but its default XMLHttpRequest value can be changed here. Values in the headers setting can also be overwritten from within the beforeSend function. */ headers?: PlainObject; /** * Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is false, ignoring the header. In jQuery 1.4 this technique also checks the 'etag' specified by the server to catch unmodified data. */ ifModified?: boolean; /** * Allow the current environment to be recognized as "local," (e.g. the filesystem), even if jQuery does not recognize it as such by default. The following protocols are currently recognized as local: file, *-extension, and widget. If the isLocal setting needs modification, it is recommended to do so once in the $.ajaxSetup() method. */ isLocal?: boolean; /** * Override the callback function name in a JSONP request. This value will be used instead of 'callback' in the 'callback=?' part of the query string in the url. So {jsonp:'onJSONPLoad'} would result in 'onJSONPLoad=?' passed to the server. As of jQuery 1.5, setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation. In this case, you should also explicitly set the jsonpCallback setting. For example, { jsonp: false, jsonpCallback: "callbackName" }. If you don't trust the target of your Ajax requests, consider setting the jsonp property to false for security reasons. */ jsonp?: string | false; /** * Specify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it'll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. As of jQuery 1.5, you can also use a function for this setting, in which case the value of jsonpCallback is set to the return value of that function. */ jsonpCallback?: string | ((this: TContext) => string); /** * The HTTP method to use for the request (e.g. "POST", "GET", "PUT"). */ method?: string; /** * A mime type to override the XHR mime type. */ mimeType?: string; /** * A password to be used with XMLHttpRequest in response to an HTTP access authentication request. */ password?: string; /** * By default, data passed in to the data option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type "application/x-www-form-urlencoded". If you want to send a DOMDocument, or other non-processed data, set this option to false. */ processData?: boolean; /** * Only applies when the "script" transport is used (e.g., cross-domain requests with "jsonp" or "script" dataType and "GET" type). Sets the charset attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script. */ scriptCharset?: string; /** * An object of numeric HTTP codes and functions to be called when the response has the corresponding code. * * If the request is successful, the status code functions take the same parameters as the success callback; if it results in an error (including 3xx redirect), they take the same parameters as the error callback. */ statusCode?: StatusCodeCallbacks; /** * A function to be called if the request succeeds. The function gets passed three arguments: The data returned from the server, formatted according to the dataType parameter or the dataFilter callback function, if specified; a string describing the status; and the jqXHR (in jQuery 1.4.x, XMLHttpRequest) object. As of jQuery 1.5, the success setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event. */ success?: TypeOrArray>; /** * Set a timeout (in milliseconds) for the request. A value of 0 means there will be no timeout. This will override any global timeout set with $.ajaxSetup(). The timeout period starts at the point the $.ajax call is made; if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent. In jQuery 1.4.x and below, the XMLHttpRequest object will be in an invalid state if the request times out; accessing any object members may throw an exception. In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period. */ timeout?: number; /** * Set this to true if you wish to use the traditional style of param serialization. */ traditional?: boolean; /** * An alias for method. You should use type if you're using versions of jQuery prior to 1.9.0. */ type?: string; /** * A username to be used with XMLHttpRequest in response to an HTTP access authentication request. */ username?: string; // ActiveXObject requires "lib": ["scripthost"] which consumers would also require /** * Callback for creating the XMLHttpRequest object. Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise. Override to provide your own implementation for XMLHttpRequest or enhancements to the factory. */ xhr?(): XMLHttpRequest; /** * An object of fieldName-fieldValue pairs to set on the native XHR object. * * In jQuery 1.5, the withCredentials property was not propagated to the native XHR and thus CORS requests requiring it would ignore this flag. For this reason, we recommend using jQuery 1.5.1+ should you require the use of it. */ xhrFields?: XHRFields; } // region StatusCodeCallbacks // #region StatusCodeCallbacks type StatusCodeCallbacks = { // region Success Status Codes // #region Success Status Codes // jQuery treats 2xx and 304 status codes as a success 200?: SuccessCallback; 201?: SuccessCallback; 202?: SuccessCallback; 203?: SuccessCallback; 204?: SuccessCallback; 205?: SuccessCallback; 206?: SuccessCallback; 207?: SuccessCallback; 208?: SuccessCallback; 209?: SuccessCallback; 210?: SuccessCallback; 211?: SuccessCallback; 212?: SuccessCallback; 213?: SuccessCallback; 214?: SuccessCallback; 215?: SuccessCallback; 216?: SuccessCallback; 217?: SuccessCallback; 218?: SuccessCallback; 219?: SuccessCallback; 220?: SuccessCallback; 221?: SuccessCallback; 222?: SuccessCallback; 223?: SuccessCallback; 224?: SuccessCallback; 225?: SuccessCallback; 226?: SuccessCallback; 227?: SuccessCallback; 228?: SuccessCallback; 229?: SuccessCallback; 230?: SuccessCallback; 231?: SuccessCallback; 232?: SuccessCallback; 233?: SuccessCallback; 234?: SuccessCallback; 235?: SuccessCallback; 236?: SuccessCallback; 237?: SuccessCallback; 238?: SuccessCallback; 239?: SuccessCallback; 240?: SuccessCallback; 241?: SuccessCallback; 242?: SuccessCallback; 243?: SuccessCallback; 244?: SuccessCallback; 245?: SuccessCallback; 246?: SuccessCallback; 247?: SuccessCallback; 248?: SuccessCallback; 249?: SuccessCallback; 250?: SuccessCallback; 251?: SuccessCallback; 252?: SuccessCallback; 253?: SuccessCallback; 254?: SuccessCallback; 255?: SuccessCallback; 256?: SuccessCallback; 257?: SuccessCallback; 258?: SuccessCallback; 259?: SuccessCallback; 260?: SuccessCallback; 261?: SuccessCallback; 262?: SuccessCallback; 263?: SuccessCallback; 264?: SuccessCallback; 265?: SuccessCallback; 266?: SuccessCallback; 267?: SuccessCallback; 268?: SuccessCallback; 269?: SuccessCallback; 270?: SuccessCallback; 271?: SuccessCallback; 272?: SuccessCallback; 273?: SuccessCallback; 274?: SuccessCallback; 275?: SuccessCallback; 276?: SuccessCallback; 277?: SuccessCallback; 278?: SuccessCallback; 279?: SuccessCallback; 280?: SuccessCallback; 281?: SuccessCallback; 282?: SuccessCallback; 283?: SuccessCallback; 284?: SuccessCallback; 285?: SuccessCallback; 286?: SuccessCallback; 287?: SuccessCallback; 288?: SuccessCallback; 289?: SuccessCallback; 290?: SuccessCallback; 291?: SuccessCallback; 292?: SuccessCallback; 293?: SuccessCallback; 294?: SuccessCallback; 295?: SuccessCallback; 296?: SuccessCallback; 297?: SuccessCallback; 298?: SuccessCallback; 299?: SuccessCallback; 304?: SuccessCallback; // #endregion // region Error Status Codes // #region Error Status Codes 300?: ErrorCallback; 301?: ErrorCallback; 302?: ErrorCallback; 303?: ErrorCallback; 305?: ErrorCallback; 306?: ErrorCallback; 307?: ErrorCallback; 308?: ErrorCallback; 309?: ErrorCallback; 310?: ErrorCallback; 311?: ErrorCallback; 312?: ErrorCallback; 313?: ErrorCallback; 314?: ErrorCallback; 315?: ErrorCallback; 316?: ErrorCallback; 317?: ErrorCallback; 318?: ErrorCallback; 319?: ErrorCallback; 320?: ErrorCallback; 321?: ErrorCallback; 322?: ErrorCallback; 323?: ErrorCallback; 324?: ErrorCallback; 325?: ErrorCallback; 326?: ErrorCallback; 327?: ErrorCallback; 328?: ErrorCallback; 329?: ErrorCallback; 330?: ErrorCallback; 331?: ErrorCallback; 332?: ErrorCallback; 333?: ErrorCallback; 334?: ErrorCallback; 335?: ErrorCallback; 336?: ErrorCallback; 337?: ErrorCallback; 338?: ErrorCallback; 339?: ErrorCallback; 340?: ErrorCallback; 341?: ErrorCallback; 342?: ErrorCallback; 343?: ErrorCallback; 344?: ErrorCallback; 345?: ErrorCallback; 346?: ErrorCallback; 347?: ErrorCallback; 348?: ErrorCallback; 349?: ErrorCallback; 350?: ErrorCallback; 351?: ErrorCallback; 352?: ErrorCallback; 353?: ErrorCallback; 354?: ErrorCallback; 355?: ErrorCallback; 356?: ErrorCallback; 357?: ErrorCallback; 358?: ErrorCallback; 359?: ErrorCallback; 360?: ErrorCallback; 361?: ErrorCallback; 362?: ErrorCallback; 363?: ErrorCallback; 364?: ErrorCallback; 365?: ErrorCallback; 366?: ErrorCallback; 367?: ErrorCallback; 368?: ErrorCallback; 369?: ErrorCallback; 370?: ErrorCallback; 371?: ErrorCallback; 372?: ErrorCallback; 373?: ErrorCallback; 374?: ErrorCallback; 375?: ErrorCallback; 376?: ErrorCallback; 377?: ErrorCallback; 378?: ErrorCallback; 379?: ErrorCallback; 380?: ErrorCallback; 381?: ErrorCallback; 382?: ErrorCallback; 383?: ErrorCallback; 384?: ErrorCallback; 385?: ErrorCallback; 386?: ErrorCallback; 387?: ErrorCallback; 388?: ErrorCallback; 389?: ErrorCallback; 390?: ErrorCallback; 391?: ErrorCallback; 392?: ErrorCallback; 393?: ErrorCallback; 394?: ErrorCallback; 395?: ErrorCallback; 396?: ErrorCallback; 397?: ErrorCallback; 398?: ErrorCallback; 399?: ErrorCallback; 400?: ErrorCallback; 401?: ErrorCallback; 402?: ErrorCallback; 403?: ErrorCallback; 404?: ErrorCallback; 405?: ErrorCallback; 406?: ErrorCallback; 407?: ErrorCallback; 408?: ErrorCallback; 409?: ErrorCallback; 410?: ErrorCallback; 411?: ErrorCallback; 412?: ErrorCallback; 413?: ErrorCallback; 414?: ErrorCallback; 415?: ErrorCallback; 416?: ErrorCallback; 417?: ErrorCallback; 418?: ErrorCallback; 419?: ErrorCallback; 420?: ErrorCallback; 421?: ErrorCallback; 422?: ErrorCallback; 423?: ErrorCallback; 424?: ErrorCallback; 425?: ErrorCallback; 426?: ErrorCallback; 427?: ErrorCallback; 428?: ErrorCallback; 429?: ErrorCallback; 430?: ErrorCallback; 431?: ErrorCallback; 432?: ErrorCallback; 433?: ErrorCallback; 434?: ErrorCallback; 435?: ErrorCallback; 436?: ErrorCallback; 437?: ErrorCallback; 438?: ErrorCallback; 439?: ErrorCallback; 440?: ErrorCallback; 441?: ErrorCallback; 442?: ErrorCallback; 443?: ErrorCallback; 444?: ErrorCallback; 445?: ErrorCallback; 446?: ErrorCallback; 447?: ErrorCallback; 448?: ErrorCallback; 449?: ErrorCallback; 450?: ErrorCallback; 451?: ErrorCallback; 452?: ErrorCallback; 453?: ErrorCallback; 454?: ErrorCallback; 455?: ErrorCallback; 456?: ErrorCallback; 457?: ErrorCallback; 458?: ErrorCallback; 459?: ErrorCallback; 460?: ErrorCallback; 461?: ErrorCallback; 462?: ErrorCallback; 463?: ErrorCallback; 464?: ErrorCallback; 465?: ErrorCallback; 466?: ErrorCallback; 467?: ErrorCallback; 468?: ErrorCallback; 469?: ErrorCallback; 470?: ErrorCallback; 471?: ErrorCallback; 472?: ErrorCallback; 473?: ErrorCallback; 474?: ErrorCallback; 475?: ErrorCallback; 476?: ErrorCallback; 477?: ErrorCallback; 478?: ErrorCallback; 479?: ErrorCallback; 480?: ErrorCallback; 481?: ErrorCallback; 482?: ErrorCallback; 483?: ErrorCallback; 484?: ErrorCallback; 485?: ErrorCallback; 486?: ErrorCallback; 487?: ErrorCallback; 488?: ErrorCallback; 489?: ErrorCallback; 490?: ErrorCallback; 491?: ErrorCallback; 492?: ErrorCallback; 493?: ErrorCallback; 494?: ErrorCallback; 495?: ErrorCallback; 496?: ErrorCallback; 497?: ErrorCallback; 498?: ErrorCallback; 499?: ErrorCallback; 500?: ErrorCallback; 501?: ErrorCallback; 502?: ErrorCallback; 503?: ErrorCallback; 504?: ErrorCallback; 505?: ErrorCallback; 506?: ErrorCallback; 507?: ErrorCallback; 508?: ErrorCallback; 509?: ErrorCallback; 510?: ErrorCallback; 511?: ErrorCallback; 512?: ErrorCallback; 513?: ErrorCallback; 514?: ErrorCallback; 515?: ErrorCallback; 516?: ErrorCallback; 517?: ErrorCallback; 518?: ErrorCallback; 519?: ErrorCallback; 520?: ErrorCallback; 521?: ErrorCallback; 522?: ErrorCallback; 523?: ErrorCallback; 524?: ErrorCallback; 525?: ErrorCallback; 526?: ErrorCallback; 527?: ErrorCallback; 528?: ErrorCallback; 529?: ErrorCallback; 530?: ErrorCallback; 531?: ErrorCallback; 532?: ErrorCallback; 533?: ErrorCallback; 534?: ErrorCallback; 535?: ErrorCallback; 536?: ErrorCallback; 537?: ErrorCallback; 538?: ErrorCallback; 539?: ErrorCallback; 540?: ErrorCallback; 541?: ErrorCallback; 542?: ErrorCallback; 543?: ErrorCallback; 544?: ErrorCallback; 545?: ErrorCallback; 546?: ErrorCallback; 547?: ErrorCallback; 548?: ErrorCallback; 549?: ErrorCallback; 550?: ErrorCallback; 551?: ErrorCallback; 552?: ErrorCallback; 553?: ErrorCallback; 554?: ErrorCallback; 555?: ErrorCallback; 556?: ErrorCallback; 557?: ErrorCallback; 558?: ErrorCallback; 559?: ErrorCallback; 560?: ErrorCallback; 561?: ErrorCallback; 562?: ErrorCallback; 563?: ErrorCallback; 564?: ErrorCallback; 565?: ErrorCallback; 566?: ErrorCallback; 567?: ErrorCallback; 568?: ErrorCallback; 569?: ErrorCallback; 570?: ErrorCallback; 571?: ErrorCallback; 572?: ErrorCallback; 573?: ErrorCallback; 574?: ErrorCallback; 575?: ErrorCallback; 576?: ErrorCallback; 577?: ErrorCallback; 578?: ErrorCallback; 579?: ErrorCallback; 580?: ErrorCallback; 581?: ErrorCallback; 582?: ErrorCallback; 583?: ErrorCallback; 584?: ErrorCallback; 585?: ErrorCallback; 586?: ErrorCallback; 587?: ErrorCallback; 588?: ErrorCallback; 589?: ErrorCallback; 590?: ErrorCallback; 591?: ErrorCallback; 592?: ErrorCallback; 593?: ErrorCallback; 594?: ErrorCallback; 595?: ErrorCallback; 596?: ErrorCallback; 597?: ErrorCallback; 598?: ErrorCallback; 599?: ErrorCallback; // #endregion } & { // Status codes not listed require type annotations when defining the callback [index: number]: SuccessCallback | ErrorCallback; }; // #endregion // Writable properties on XMLHttpRequest interface XHRFields extends Partial> { msCaching?: string; } } interface Transport { send(headers: PlainObject, completeCallback: Transport.SuccessCallback): void; abort(): void; } namespace Transport { type SuccessCallback = (status: number, statusText: Ajax.TextStatus, responses?: PlainObject, headers?: string) => void; } /** * @see \`{@link https://api.jquery.com/jquery.ajax/#jqXHR }\` */ interface jqXHR extends Promise3, never, Ajax.SuccessTextStatus, Ajax.ErrorTextStatus, never, jqXHR, string, never>, Pick, Partial> { responseJSON?: any; abort(statusText?: string): void; /** * Determine the current state of a Deferred object. * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; statusCode(map: Ajax.StatusCodeCallbacks): void; } namespace jqXHR { interface DoneCallback> extends Deferred.Callback3 { } interface FailCallback extends Deferred.Callback3 { } interface AlwaysCallback> extends Deferred.Callback3 { } } // #endregion // region Callbacks // #region Callbacks interface CallbacksStatic { /** * A multi-purpose callbacks list object that provides a powerful way to manage callback lists. * @param flags An optional list of space-separated flags that change how the callback list behaves. * @see \`{@link https://api.jquery.com/jQuery.Callbacks/ }\` * @since 1.7 */ // tslint:disable-next-line:ban-types no-unnecessary-generics (flags?: string): Callbacks; } // tslint:disable-next-line:ban-types interface Callbacks { /** * Add a callback or a collection of callbacks to a callback list. * @param callback A function, or array of functions, that are to be added to the callback list. * @param callbacks A function, or array of functions, that are to be added to the callback list. * @see \`{@link https://api.jquery.com/callbacks.add/ }\` * @since 1.7 * @example ​ ````Use callbacks.add() to add new callbacks to a callback list: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo: " + value ); }; ​ // Another function to also be added to the list var bar = function( value ) { console.log( "bar: " + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the function "foo" to the list callbacks.add( foo ); ​ // Fire the items on the list callbacks.fire( "hello" ); // Outputs: "foo: hello" ​ // Add the function "bar" to the list callbacks.add( bar ); ​ // Fire the items on the list again callbacks.fire( "world" ); ​ // Outputs: // "foo: world" // "bar: world" ``` */ add(callback: TypeOrArray, ...callbacks: Array>): this; /** * Disable a callback list from doing anything more. * @see \`{@link https://api.jquery.com/callbacks.disable/ }\` * @since 1.7 * @example ​ ````Use callbacks.disable() to disable further calls to a callback list: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the above function to the list callbacks.add( foo ); ​ // Fire the items on the list callbacks.fire( "foo" ); // Outputs: foo ​ // Disable further calls being possible callbacks.disable(); ​ // Attempt to fire with "foobar" as an argument callbacks.fire( "foobar" ); // foobar isn't output ``` */ disable(): this; /** * Determine if the callbacks list has been disabled. * @see \`{@link https://api.jquery.com/callbacks.disabled/ }\` * @since 1.7 * @example ​ ````Use callbacks.disabled() to determine if the callbacks list has been disabled: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo:" + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the logging function to the callback list callbacks.add( foo ); ​ // Fire the items on the list, passing an argument callbacks.fire( "hello" ); // Outputs "foo: hello" ​ // Disable the callbacks list callbacks.disable(); ​ // Test the disabled state of the list console.log ( callbacks.disabled() ); // Outputs: true ``` */ disabled(): boolean; /** * Remove all of the callbacks from a list. * @see \`{@link https://api.jquery.com/callbacks.empty/ }\` * @since 1.7 * @example ​ ````Use callbacks.empty() to empty a list of callbacks: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value1, value2 ) { console.log( "foo: " + value1 + "," + value2 ); }; ​ // Another function to also be added to the list var bar = function( value1, value2 ) { console.log( "bar: " + value1 + "," + value2 ); }; ​ var callbacks = $.Callbacks(); ​ // Add the two functions callbacks.add( foo ); callbacks.add( bar ); ​ // Empty the callbacks list callbacks.empty(); ​ // Check to ensure all callbacks have been removed console.log( callbacks.has( foo ) ); // false console.log( callbacks.has( bar ) ); // false ``` */ empty(): this; /** * Call all of the callbacks with the given arguments. * @param args The argument or list of arguments to pass back to the callback list. * @see \`{@link https://api.jquery.com/callbacks.fire/ }\` * @since 1.7 * @example ​ ````Use callbacks.fire() to invoke the callbacks in a list with any arguments that have been passed: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo:" + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the function "foo" to the list callbacks.add( foo ); ​ // Fire the items on the list callbacks.fire( "hello" ); // Outputs: "foo: hello" callbacks.fire( "world" ); // Outputs: "foo: world" ​ // Add another function to the list var bar = function( value ){ console.log( "bar:" + value ); }; ​ // Add this function to the list callbacks.add( bar ); ​ // Fire the items on the list again callbacks.fire( "hello again" ); // Outputs: // "foo: hello again" // "bar: hello again" ``` */ fire(...args: any[]): this; /** * Determine if the callbacks have already been called at least once. * @see \`{@link https://api.jquery.com/callbacks.fired/ }\` * @since 1.7 * @example ​ ````Use callbacks.fired() to determine if the callbacks in a list have been called at least once: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo:" + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the function "foo" to the list callbacks.add( foo ); ​ // Fire the items on the list callbacks.fire( "hello" ); // Outputs: "foo: hello" callbacks.fire( "world" ); // Outputs: "foo: world" ​ // Test to establish if the callbacks have been called console.log( callbacks.fired() ); ``` */ fired(): boolean; /** * Call all callbacks in a list with the given context and arguments. * @param context A reference to the context in which the callbacks in the list should be fired. * @param args An argument, or array of arguments, to pass to the callbacks in the list. * @see \`{@link https://api.jquery.com/callbacks.fireWith/ }\` * @since 1.7 * @example ​ ````Use callbacks.fireWith() to fire a list of callbacks with a specific context and an array of arguments: ```javascript // A sample logging function to be added to a callbacks list var log = function( value1, value2 ) { console.log( "Received: " + value1 + "," + value2 ); }; ​ var callbacks = $.Callbacks(); ​ // Add the log method to the callbacks list callbacks.add( log ); ​ // Fire the callbacks on the list using the context "window" // and an arguments array ​ callbacks.fireWith( window, [ "foo","bar" ] ); // Outputs: "Received: foo, bar" ``` */ fireWith(context: object, args?: ArrayLike): this; /** * Determine whether or not the list has any callbacks attached. If a callback is provided as an argument, determine whether it is in a list. * @param callback The callback to search for. * @see \`{@link https://api.jquery.com/callbacks.has/ }\` * @since 1.7 * @example ​ ````Use callbacks.has() to check if a callback list contains a specific callback: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value1, value2 ) { console.log( "Received: " + value1 + "," + value2 ); }; ​ // A second function which will not be added to the list var bar = function( value1, value2 ) { console.log( "foobar" ); }; ​ var callbacks = $.Callbacks(); ​ // Add the log method to the callbacks list callbacks.add( foo ); ​ // Determine which callbacks are in the list console.log( callbacks.has( foo ) ); // true console.log( callbacks.has( bar ) ); // false ``` */ has(callback?: T): boolean; /** * Lock a callback list in its current state. * @see \`{@link https://api.jquery.com/callbacks.lock/ }\` * @since 1.7 * @example ​ ````Use callbacks.lock() to lock a callback list to avoid further changes being made to the list state: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo:" + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the logging function to the callback list callbacks.add( foo ); ​ // Fire the items on the list, passing an argument callbacks.fire( "hello" ); // Outputs "foo: hello" ​ // Lock the callbacks list callbacks.lock(); ​ // Try firing the items again callbacks.fire( "world" ); ​ // As the list was locked, no items were called, // so "world" isn't logged ``` * @example ​ ````Use callbacks.lock() to lock a callback list with "memory," and then resume using the list: ```html callbacks.lock demo
      ​ ``` */ lock(): this; /** * Determine if the callbacks list has been locked. * @see \`{@link https://api.jquery.com/callbacks.locked/ }\` * @since 1.7 * @example ​ ````Use callbacks.locked() to determine the lock-state of a callback list: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo: " + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the logging function to the callback list callbacks.add( foo ); ​ // Fire the items on the list, passing an argument callbacks.fire( "hello" ); // Outputs "foo: hello" ​ // Lock the callbacks list callbacks.lock(); ​ // Test the lock-state of the list console.log ( callbacks.locked() ); // true ``` */ locked(): boolean; /** * Remove a callback or a collection of callbacks from a callback list. * @param callbacks A function, or array of functions, that are to be removed from the callback list. * @see \`{@link https://api.jquery.com/callbacks.remove/ }\` * @since 1.7 * @example ​ ````Use callbacks.remove() to remove callbacks from a callback list: ```javascript // A sample logging function to be added to a callbacks list var foo = function( value ) { console.log( "foo: " + value ); }; ​ var callbacks = $.Callbacks(); ​ // Add the function "foo" to the list callbacks.add( foo ); ​ // Fire the items on the list callbacks.fire( "hello" ); // Outputs: "foo: hello" ​ // Remove "foo" from the callback list callbacks.remove( foo ); ​ // Fire the items on the list again callbacks.fire( "world" ); ​ // Nothing output as "foo" is no longer in the list ``` */ remove(...callbacks: T[]): this; } // #endregion // region CSS hooks // #region CSS hooks // Workaround for TypeScript 2.3 which does not have support for weak types handling. type CSSHook = Partial<_CSSHook> & ( Pick<_CSSHook, 'get'> | Pick<_CSSHook, 'set'> ); interface _CSSHook { get(elem: TElement, computed: any, extra: any): any; set(elem: TElement, value: any): void; } interface CSSHooks { // Set to HTMLElement to minimize breaks but should probably be Element. [propertyName: string]: CSSHook; } // #endregion // region Deferred // #region Deferred /** * Any object that has a then method. */ interface Thenable extends PromiseLike { } // Type parameter guide // -------------------- // Each type parameter represents a parameter in one of the three possible callbacks. // // The first letter indicates which position the parameter is in. // // T = A = 1st position // U = B = 2nd position // V = C = 3rd position // S = R = rest position // // The second letter indicates which whether it is a [R]esolve, Re[J]ect, or [N]otify value. // // The third letter indicates whether the value is returned in the [D]one filter, [F]ail filter, or [P]rogress filter. /** * This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred. * @see \`{@link https://api.jquery.com/Types/#Promise }\` */ interface PromiseBase { /** * Add handlers to be called when the Deferred object is either resolved or rejected. * @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected. * @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected. * @see \`{@link https://api.jquery.com/deferred.always/ }\` * @since 1.6 * @example ​ ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method. ```javascript $.get( "test.php" ).always(function() { alert( "$.get completed with success or error callback arguments" ); }); ``` */ always(alwaysCallback: TypeOrArray>, ...alwaysCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object is resolved. * @param doneCallback A function, or array of functions, that are called when the Deferred is resolved. * @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved. * @see \`{@link https://api.jquery.com/deferred.done/ }\` * @since 1.5 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method. ```javascript $.get( "test.php" ).done(function() { alert( "$.get succeeded" ); }); ``` * @example ​ ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions: ```html deferred.done demo

      Ready...

      ​ ``` */ done(doneCallback: TypeOrArray>, ...doneCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object is rejected. * @param failCallback A function, or array of functions, that are called when the Deferred is rejected. * @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected. * @see \`{@link https://api.jquery.com/deferred.fail/ }\` * @since 1.5 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods. ```javascript $.get( "test.php" ) .done(function() { alert( "$.get succeeded" ); }) .fail(function() { alert( "$.get failed!" ); }); ``` */ fail(failCallback: TypeOrArray>, ...failCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object generates progress notifications. * @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications. * @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates * progress notifications. * @see \`{@link https://api.jquery.com/deferred.progress/ }\` * @since 1.7 */ progress(progressCallback: TypeOrArray>, ...progressCallbacks: Array>>): this; /** * Return a Deferred's Promise object. * @param target Object onto which the promise methods have to be attached * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 * @example ​ ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first "wins" and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds "working..." to the document body. ```javascript function asyncEvent() { var dfd = jQuery.Deferred(); ​ // Resolve after a random interval setTimeout(function() { dfd.resolve( "hurray" ); }, Math.floor( 400 + Math.random() * 2000 ) ); ​ // Reject after a random interval setTimeout(function() { dfd.reject( "sorry" ); }, Math.floor( 400 + Math.random() * 2000 ) ); ​ // Show a "working..." message every half-second setTimeout(function working() { if ( dfd.state() === "pending" ) { dfd.notify( "working... " ); setTimeout( working, 500 ); } }, 1 ); ​ // Return the Promise so caller can't change the Deferred return dfd.promise(); } ​ // Attach a done, fail, and progress handler for the asyncEvent $.when( asyncEvent() ).then( function( status ) { alert( status + ", things are going well" ); }, function( status ) { alert( status + ", you fail this time" ); }, function( status ) { $( "body" ).append( status ); } ); ``` */ promise(target: TTarget): this & TTarget; /** * Return a Deferred's Promise object. * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 * @example ​ ````Use the target argument to promote an existing object to a Promise: ```javascript // Existing object var obj = { hello: function( name ) { alert( "Hello " + name ); } }, // Create a Deferred defer = $.Deferred(); ​ // Set object as a promise defer.promise( obj ); ​ // Resolve the deferred defer.resolve( "John" ); ​ // Use the object as a Promise obj.done(function( name ) { obj.hello( name ); // Will alert "Hello John" }).hello( "Karl" ); // Will alert "Hello Karl" ``` */ promise(): this; /** * Determine the current state of a Deferred object. * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; // region pipe // #region pipe /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | AJF, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | AJF, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: null, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: null, progressFilter?: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | AJF, progressFilter?: null): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | AJF, progressFilter?: null): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter?: null, progressFilter?: null): PromiseBase; // #endregion // region then // #region then /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. ```javascript $.get( "test.php" ).then( function() { alert( "$.get succeeded" ); }, function() { alert( "$.get failed!" ); } ); ``` * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | ARF, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | ARF, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: null, progressFilter: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: null, progressFilter?: (t: TN, u: UN, v: VN, ...s: SN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. ```javascript $.get( "test.php" ).then( function() { alert( "$.get succeeded" ); }, function() { alert( "$.get failed!" ); } ); ``` * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | ARF, progressFilter?: null): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: (t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | ARF, progressFilter?: null): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (t: TR, u: UR, v: VR, ...s: SR[]) => PromiseBase | Thenable | ARD, failFilter?: null, progressFilter?: null): PromiseBase; // #endregion /** * Add handlers to be called when the Deferred object is rejected. * @param failFilter A function that is called when the Deferred is rejected. * @see \`{@link https://api.jquery.com/deferred.catch/ }\` * @since 3.0 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method. ```javascript $.get( "test.php" ) .then( function() { alert( "$.get succeeded" ); } ) .catch( function() { alert( "$.get failed!" ); } ); ``` */ catch( failFilter?: ((t: TJ, u: UJ, v: VJ, ...s: SJ[]) => PromiseBase | Thenable | ARF) | null): PromiseBase; } /** * This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred. * @see \`{@link https://api.jquery.com/Types/#Promise }\` */ interface Promise3 extends PromiseBase { } /** * This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred. * @see \`{@link https://api.jquery.com/Types/#Promise }\` */ interface Promise2 extends PromiseBase { } /** * This object provides a subset of the methods of the Deferred object (then, done, fail, always, pipe, progress, state and promise) to prevent users from changing the state of the Deferred. * @see \`{@link https://api.jquery.com/Types/#Promise }\` */ interface Promise extends PromiseBase { } interface DeferredStatic { // https://jquery.com/upgrade-guide/3.0/#callback-exit exceptionHook: any; /** * 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. * @param beforeStart A function that is called just before the constructor returns. * @see \`{@link https://api.jquery.com/jQuery.Deferred/ }\` * @since 1.5 */ (beforeStart?: (this: Deferred, deferred: Deferred) => void): Deferred; } interface Deferred { /** * Call the progressCallbacks on a Deferred object with the given args. * @param args Optional arguments that are passed to the progressCallbacks. * @see \`{@link https://api.jquery.com/deferred.notify/ }\` * @since 1.7 */ notify(...args: TN[]): this; /** * Call the progressCallbacks on a Deferred object with the given context and args. * @param context Context passed to the progressCallbacks as the this object. * @param args An optional array of arguments that are passed to the progressCallbacks. * @see \`{@link https://api.jquery.com/deferred.notifyWith/ }\` * @since 1.7 */ notifyWith(context: object, args?: ArrayLike): this; /** * Reject a Deferred object and call any failCallbacks with the given args. * @param args Optional arguments that are passed to the failCallbacks. * @see \`{@link https://api.jquery.com/deferred.reject/ }\` * @since 1.5 */ reject(...args: TJ[]): this; /** * Reject a Deferred object and call any failCallbacks with the given context and args. * @param context Context passed to the failCallbacks as the this object. * @param args An optional array of arguments that are passed to the failCallbacks. * @see \`{@link https://api.jquery.com/deferred.rejectWith/ }\` * @since 1.5 */ rejectWith(context: object, args?: ArrayLike): this; /** * Resolve a Deferred object and call any doneCallbacks with the given args. * @param args Optional arguments that are passed to the doneCallbacks. * @see \`{@link https://api.jquery.com/deferred.resolve/ }\` * @since 1.5 */ resolve(...args: TR[]): this; /** * Resolve a Deferred object and call any doneCallbacks with the given context and args. * @param context Context passed to the doneCallbacks as the this object. * @param args An optional array of arguments that are passed to the doneCallbacks. * @see \`{@link https://api.jquery.com/deferred.resolveWith/ }\` * @since 1.5 */ resolveWith(context: object, args?: ArrayLike): this; /** * Add handlers to be called when the Deferred object is either resolved or rejected. * @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected. * @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected. * @see \`{@link https://api.jquery.com/deferred.always/ }\` * @since 1.6 * @example ​ ````Since the jQuery.get() method returns a jqXHR object, which is derived from a Deferred object, we can attach a callback for both success and error using the deferred.always() method. ```javascript $.get( "test.php" ).always(function() { alert( "$.get completed with success or error callback arguments" ); }); ``` */ always(alwaysCallback: TypeOrArray>, ...alwaysCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object is resolved. * @param doneCallback A function, or array of functions, that are called when the Deferred is resolved. * @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved. * @see \`{@link https://api.jquery.com/deferred.done/ }\` * @since 1.5 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach a success callback using the .done() method. ```javascript $.get( "test.php" ).done(function() { alert( "$.get succeeded" ); }); ``` * @example ​ ````Resolve a Deferred object when the user clicks a button, triggering a number of callback functions: ```html deferred.done demo

      Ready...

      ​ ``` */ done(doneCallback: TypeOrArray>, ...doneCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object is rejected. * @param failCallback A function, or array of functions, that are called when the Deferred is rejected. * @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected. * @see \`{@link https://api.jquery.com/deferred.fail/ }\` * @since 1.5 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred, you can attach a success and failure callback using the deferred.done() and deferred.fail() methods. ```javascript $.get( "test.php" ) .done(function() { alert( "$.get succeeded" ); }) .fail(function() { alert( "$.get failed!" ); }); ``` */ fail(failCallback: TypeOrArray>, ...failCallbacks: Array>>): this; /** * Add handlers to be called when the Deferred object generates progress notifications. * @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications. * @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates * progress notifications. * @see \`{@link https://api.jquery.com/deferred.progress/ }\` * @since 1.7 */ progress(progressCallback: TypeOrArray>, ...progressCallbacks: Array>>): this; /** * Return a Deferred's Promise object. * @param target Object onto which the promise methods have to be attached * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 * @example ​ ````Use the target argument to promote an existing object to a Promise: ```javascript // Existing object var obj = { hello: function( name ) { alert( "Hello " + name ); } }, // Create a Deferred defer = $.Deferred(); ​ // Set object as a promise defer.promise( obj ); ​ // Resolve the deferred defer.resolve( "John" ); ​ // Use the object as a Promise obj.done(function( name ) { obj.hello( name ); // Will alert "Hello John" }).hello( "Karl" ); // Will alert "Hello Karl" ``` */ promise(target: TTarget): Promise & TTarget; /** * Return a Deferred's Promise object. * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 * @example ​ ````Create a Deferred and set two timer-based functions to either resolve or reject the Deferred after a random interval. Whichever one fires first "wins" and will call one of the callbacks. The second timeout has no effect since the Deferred is already complete (in a resolved or rejected state) from the first timeout action. Also set a timer-based progress notification function, and call a progress handler that adds "working..." to the document body. ```javascript function asyncEvent() { var dfd = jQuery.Deferred(); ​ // Resolve after a random interval setTimeout(function() { dfd.resolve( "hurray" ); }, Math.floor( 400 + Math.random() * 2000 ) ); ​ // Reject after a random interval setTimeout(function() { dfd.reject( "sorry" ); }, Math.floor( 400 + Math.random() * 2000 ) ); ​ // Show a "working..." message every half-second setTimeout(function working() { if ( dfd.state() === "pending" ) { dfd.notify( "working... " ); setTimeout( working, 500 ); } }, 1 ); ​ // Return the Promise so caller can't change the Deferred return dfd.promise(); } ​ // Attach a done, fail, and progress handler for the asyncEvent $.when( asyncEvent() ).then( function( status ) { alert( status + ", things are going well" ); }, function( status ) { alert( status + ", you fail this time" ); }, function( status ) { $( "body" ).append( status ); } ); ``` */ promise(): Promise; /** * Determine the current state of a Deferred object. * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; // region pipe // #region pipe /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: (...t: TJ[]) => PromiseBase | Thenable | AJF, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: (...t: TJ[]) => PromiseBase | Thenable | AJF, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: null, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: null, progressFilter?: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: (...t: TJ[]) => PromiseBase | Thenable | AJF, progressFilter?: null): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.pipe( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: null, failFilter: (...t: TJ[]) => PromiseBase | Thenable | AJF, progressFilter?: null): PromiseBase; /** * Utility method to filter and/or chain Deferreds. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated ​ Deprecated since 1.8. Use \`{@link then }\`. * * **Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function. * * **Solution**: In most cases it is sufficient to change all occurrences of `.pipe()` to `.then()`. Ensure that you aren't relying on context/state propagation (e.g., using `this`) or synchronous callback invocation, which were dropped from `.then()` for Promises/A+ interoperability as of jQuery 3.0. * @example ​ ````Filter resolve value: ```javascript var defer = $.Deferred(), filtered = defer.pipe(function( value ) { return value * 2; }); ​ defer.resolve( 5 ); filtered.done(function( value ) { alert( "Value is ( 2*5 = ) 10: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.pipe(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ pipe( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter?: null, progressFilter?: null): PromiseBase; // #endregion // region then // #region then /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter A function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. ```javascript $.get( "test.php" ).then( function() { alert( "$.get succeeded" ); }, function() { alert( "$.get failed!" ); } ); ``` * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: (...t: TJ[]) => PromiseBase | Thenable | ARF, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter A function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: (...t: TJ[]) => PromiseBase | Thenable | ARF, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter A function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: null, progressFilter: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter A function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: null, progressFilter?: (...t: TN[]) => PromiseBase | Thenable | ANP): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can attach handlers using the .then method. ```javascript $.get( "test.php" ).then( function() { alert( "$.get succeeded" ); }, function() { alert( "$.get failed!" ); } ); ``` * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter: (...t: TJ[]) => PromiseBase | Thenable | ARF, progressFilter?: null): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter reject value: ```javascript var defer = $.Deferred(), filtered = defer.then( null, function( value ) { return value * 3; }); ​ defer.reject( 6 ); filtered.fail(function( value ) { alert( "Value is ( 3*6 = ) 18: " + value ); }); ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: null, failFilter: (...t: TJ[]) => PromiseBase | Thenable | ARF, progressFilter?: null): PromiseBase; /** * Add handlers to be called when the Deferred object is resolved, rejected, or still in progress. * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 * @example ​ ````Filter the resolve value: ```html deferred.then demo

      ​ ``` * @example ​ ````Chain tasks: ```javascript var request = $.ajax( url, { dataType: "json" } ), chained = request.then(function( data ) { return $.ajax( url2, { data: { user: data.userId } } ); }); ​ chained.done(function( data ) { // data retrieved from url2 as provided by the first request }); ``` */ then( doneFilter: (...t: TR[]) => PromiseBase | Thenable | ARD, failFilter?: null, progressFilter?: null): PromiseBase; // #endregion /** * Add handlers to be called when the Deferred object is rejected. * @param failFilter A function that is called when the Deferred is rejected. * @see \`{@link https://api.jquery.com/deferred.catch/ }\` * @since 3.0 * @example ​ ````Since the jQuery.get method returns a jqXHR object, which is derived from a Deferred object, we can rejection handlers using the .catch method. ```javascript $.get( "test.php" ) .then( function() { alert( "$.get succeeded" ); } ) .catch( function() { alert( "$.get failed!" ); } ); ``` */ catch( failFilter?: ((...t: TJ[]) => PromiseBase | Thenable | ARF) | null): PromiseBase; } namespace Deferred { type CallbackBase = (t: T, u: U, v: V, ...r: R[]) => void; interface Callback3 extends CallbackBase { } type Callback = (...args: T[]) => void; /** * @deprecated ​ Deprecated. Use \`{@link Callback }\`. */ interface DoneCallback extends Callback { } /** * @deprecated ​ Deprecated. Use \`{@link Callback }\`. */ interface FailCallback extends Callback { } /** * @deprecated ​ Deprecated. Use \`{@link Callback }\`. */ interface AlwaysCallback extends Callback { } /** * @deprecated ​ Deprecated. Use \`{@link Callback }\`. */ interface ProgressCallback extends Callback { } } // #endregion // region Effects // #region Effects type Duration = number | 'fast' | 'slow'; /** * @see \`{@link https://api.jquery.com/animate/#animate-properties-options }\` */ interface EffectsOptions extends PlainObject { /** * A function to be called when the animation on an element completes or stops without completing (its Promise object is either resolved or rejected). */ always?(this: TElement, animation: Animation, jumpedToEnd: boolean): void; /** * A function that is called once the animation on an element is complete. */ complete?(this: TElement): void; /** * A function to be called when the animation on an element completes (its Promise object is resolved). */ done?(this: TElement, animation: Animation, jumpedToEnd: boolean): void; /** * A string or number determining how long the animation will run. */ duration?: Duration; /** * A string indicating which easing function to use for the transition. */ easing?: string; /** * A function to be called when the animation on an element fails to complete (its Promise object is rejected). */ fail?(this: TElement, animation: Animation, jumpedToEnd: boolean): void; /** * A function to be called after each step of the animation, only once per animated element regardless of the number of animated properties. */ progress?(this: TElement, animation: Animation, progress: number, remainingMs: number): void; /** * A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option can also accept a string, in which case the animation is added to the queue represented by that string. When a custom queue name is used the animation does not automatically start; you must call .dequeue("queuename") to start it. */ queue?: boolean | string; /** * An object containing one or more of the CSS properties defined by the properties argument and their corresponding easing functions. */ specialEasing?: PlainObject; /** * A function to call when the animation on an element begins. */ start?(this: TElement, animation: Animation): void; /** * A function to be called for each animated property of each animated element. This function provides an opportunity to modify the Tween object to change the value of the property before it is set. */ step?(this: TElement, now: number, tween: Tween): void; } // region Animation // #region Animation /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ interface AnimationStatic { /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ (element: TElement, props: PlainObject, opts: EffectsOptions): Animation; /** * During the initial setup, `jQuery.Animation` will call any callbacks that have been registered through `jQuery.Animation.prefilter( function( element, props, opts ) )`. * @param callback The prefilter will have `this` set to an animation object, and you can modify any of the `props` or * `opts` however you need. The prefilter _may_ return its own promise which also implements `stop()`, * in which case, processing of prefilters stops. If the prefilter is not trying to override the animation * entirely, it should return `undefined` or some other falsy value. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#prefilters }\` * @since 1.8 */ prefilter( callback: (this: Animation, element: TElement, props: PlainObject, opts: EffectsOptions) => Animation | _Falsy | void, prepend?: boolean ): void; /** * A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property. * * You can override the default process for creating a tween in order to provide your own tween object by using `jQuery.Animation.tweener( props, callback( prop, value ) )`. * @param props A space separated list of properties to be passed to your tweener, or `"*"` if it should be called * for all properties. * @param callback The callback will be called with `this` being an `Animation` object. The tweener function will * generally start with `var tween = this.createTween( prop, value );`, but doesn't nessecarily need to * use the `jQuery.Tween()` factory. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweeners }\` * @since 1.8 */ tweener(props: string, callback: Tweener): void; } /** * The promise will be resolved when the animation reaches its end, and rejected when terminated early. The context of callbacks attached to the promise will be the element, and the arguments will be the `Animation` object and a boolean `jumpedToEnd` which when true means the animation was stopped with `gotoEnd`, when `undefined` the animation completed naturally. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ interface Animation extends Promise3< Animation, Animation, Animation, true | undefined, false, number, never, never, number > { /** * The duration specified in ms * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ duration: number; /** * The element being animatied * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ elem: TElement; /** * The final value of each property animating * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ props: PlainObject; /** * The animation options * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ opts: EffectsOptions; /** * The original properties before being filtered * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ originalProps: PlainObject; /** * The original options before being filtered * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ originalOpts: EffectsOptions; /** * The numeric value of `new Date()` when the animation began * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ startTime: number; /** * The animations tweens. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ tweens: Array>; /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ createTween(propName: string, finalValue: number): Tween; /** * Stops the animation early, optionally going to the end. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#animation-factory }\` * @since 1.8 */ stop(gotoEnd: boolean): this; } /** * A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweeners }\` * @since 1.8 */ type Tweener = (this: Animation, propName: string, finalValue: number) => Tween; /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ interface TweenStatic { /** * `jQuery.Tween.propHooks[ prop ]` is a hook point that replaces `jQuery.fx.step[ prop ]` (which is being deprecated.) These hooks are used by the tween to get and set values on elements. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\` * @since 1.8 * @example ```javascript jQuery.Tween.propHooks[ property ] = { get: function( tween ) { // get tween.prop from tween.elem and return it }, set: function( tween ) { // set tween.prop on tween.elem to tween.now + tween.unit } } ``` */ propHooks: PropHooks; /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ (elem: TElement, options: EffectsOptions, prop: string, end: number, easing?: string, unit?: string): Tween; } /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ // This should be a class but doesn't work correctly under the JQuery namespace. Tween should be an inner class of jQuery. interface Tween { /** * The easing used * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ easing: string; /** * The element being animated * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ elem: TElement; /** * The ending value of the tween * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ end: number; /** * The current value of the tween * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ now: number; /** * A reference to the animation options * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ options: EffectsOptions; // Undocumented. Is this intended to be public? pos?: number; /** * The property being animated * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ prop: string; /** * The starting value of the tween * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ start: number; /** * The CSS unit for the tween * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ unit: string; /** * Reads the current value for property from the element * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ cur(): any; /** * Updates the value for the property on the animated elemd. * @param progress A number from 0 to 1. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tweens }\` * @since 1.8 */ run(progress: number): this; } /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\` * @since 1.8 */ // Workaround for TypeScript 2.3 which does not have support for weak types handling. type PropHook = { /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\` * @since 1.8 */ get(tween: Tween): any; } | { /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\` * @since 1.8 */ set(tween: Tween): void; } | { [key: string]: never; }; /** * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#tween-hooks }\` * @since 1.8 */ interface PropHooks { [property: string]: PropHook; } // #endregion // region Easing // #region Easing type EasingMethod = (percent: number) => number; interface Easings { [name: string]: EasingMethod; } // #endregion // region Effects (fx) // #region Effects (fx) interface Effects { /** * The rate (in milliseconds) at which animations fire. * @see \`{@link https://api.jquery.com/jQuery.fx.interval/ }\` * @since 1.4.3 * @deprecated ​ Deprecated since 3.0. See \`{@link https://api.jquery.com/jQuery.fx.interval/ }\`. * * **Cause**: As of jQuery 3.0 the `jQuery.fx.interval` property can be used to change the animation interval only on browsers that do not support the `window.requestAnimationFrame()` method. That is currently only Internet Explorer 9 and the Android Browser. Once support is dropped for these browsers, the property will serve no purpose and it will be removed. * * **Solution**: Find and remove code that changes or uses `jQuery.fx.interval`. If the value is being used by code in your page or a plugin, the code may be making assumptions that are no longer valid. The default value of `jQuery.fx.interval` is `13` (milliseconds), which could be used instead of accessing this property. * @example ​ ````Cause all animations to run with less frames. ```html jQuery.fx.interval demo

      ``` */ interval: number; /** * Globally disable all animations. * @see \`{@link https://api.jquery.com/jQuery.fx.off/ }\` * @since 1.3 * @example ​ ````Toggle animation on and off ```html jQuery.fx.off demo
      ``` */ off: boolean; /** * @deprecated ​ Deprecated since 1.8. Use \`{@link Tween.propHooks jQuery.Tween.propHooks}\`. * * `jQuery.fx.step` functions are being replaced by `jQuery.Tween.propHooks` and may eventually be removed, but are still supported via the default tween propHook. */ step: PlainObject>; /** * _overridable_ Clears up the `setInterval` * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\` * @since 1.8 */ stop(): void; /** * Calls `.run()` on each object in the `jQuery.timers` array, removing it from the array if `.run()` returns a falsy value. Calls `jQuery.fx.stop()` whenever there are no timers remaining. * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\` * @since 1.8 */ tick(): void; /** * _overridable_ Creates a `setInterval` if one doesn't already exist, and pushes `tickFunction` to the `jQuery.timers` array. `tickFunction` should also have `anim`, `elem`, and `queue` properties that reference the animation object, animated element, and queue option to facilitate `jQuery.fn.stop()` * * By overriding `fx.timer` and `fx.stop` you should be able to implement any animation tick behaviour you desire. (like using `requestAnimationFrame` instead of `setTimeout`.) * * There is an example of overriding the timer loop in \`{@link https://github.com/gnarf37/jquery-requestAnimationFrame jquery.requestAnimationFrame}\` * @see \`{@link https://gist.github.com/gnarf/54829d408993526fe475#plugging-in-a-different-timer-loop }\` * @since 1.8 */ timer(tickFunction: TickFunction): void; } /** * @deprecated ​ Deprecated since 1.8. Use \`{@link Tween.propHooks jQuery.Tween.propHooks}\`. * * `jQuery.fx.step` functions are being replaced by `jQuery.Tween.propHooks` and may eventually be removed, but are still supported via the default tween propHook. */ type AnimationHook = (fx: Tween) => void; interface TickFunction { anim: Animation; elem: TElement; queue: boolean | string; (): any; } // #endregion // region Queue // #region Queue // TODO: Is the first element always a string or is that specific to the 'fx' queue? type Queue = { 0: string; } & Array>; type QueueFunction = (this: TElement, next: () => void) => void; // #endregion // region Speed // #region Speed // Workaround for TypeScript 2.3 which does not have support for weak types handling. type SpeedSettings = { /** * A string or number determining how long the animation will run. */ duration: Duration; } | { /** * A string indicating which easing function to use for the transition. */ easing: string; } | { /** * A function to call once the animation is complete. */ complete(this: TElement): void; } | { [key: string]: never; }; // #endregion // #endregion // region Events // #region Events // region Event // #region Event // This should be a class but doesn't work correctly under the JQuery namespace. Event should be an inner class of jQuery. /** * jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods. * * Those properties are all documented, and accompanied by examples, on the \`{@link http://api.jquery.com/category/events/event-object/ Event object}\` page. * * The standard events in the Document Object Model are: `blur`, `focus`, `load`, `resize`, `scroll`, `unload`, `beforeunload`, `click`, `dblclick`, `mousedown`, `mouseup`, `mousemove`, `mouseover`, `mouseout`, `mouseenter`, `mouseleave`, `change`, `select`, `submit`, `keydown`, `keypress`, and `keyup`. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any. * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` */ interface EventStatic { /** * The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional. * * Check \`{@link https://api.jquery.com/trigger/ trigger}\`'s documentation to see how to combine it with your own event object. * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` * @since 1.6 * @example ```javascript //Create a new jQuery.Event object without the "new" operator. var e = jQuery.Event( "click" ); ​ // trigger an artificial click event jQuery( "body" ).trigger( e ); ``` * @example ```javascript // Create a new jQuery.Event object with specified event properties. var e = jQuery.Event( "keydown", { keyCode: 64 } ); ​ // trigger an artificial keydown event with keyCode 64 jQuery( "body" ).trigger( e ); ``` */ (event: string, properties?: T): Event & T; /** * The jQuery.Event constructor is exposed and can be used when calling trigger. The new operator is optional. * * Check \`{@link https://api.jquery.com/trigger/ trigger}\`'s documentation to see how to combine it with your own event object. * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` * @since 1.6 * @example ```javascript //Create a new jQuery.Event object without the "new" operator. var e = jQuery.Event( "click" ); ​ // trigger an artificial click event jQuery( "body" ).trigger( e ); ``` * @example ```javascript // Create a new jQuery.Event object with specified event properties. var e = jQuery.Event( "keydown", { keyCode: 64 } ); ​ // trigger an artificial keydown event with keyCode 64 jQuery( "body" ).trigger( e ); ``` */ new (event: string, properties?: T): Event & T; } /** * jQuery's event system normalizes the event object according to W3C standards. The event object is guaranteed to be passed to the event handler (no checks for window.event required). It normalizes the target, relatedTarget, which, metaKey and pageX/Y properties and provides both stopPropagation() and preventDefault() methods. * * Those properties are all documented, and accompanied by examples, on the \`{@link http://api.jquery.com/category/events/event-object/ Event object}\` page. * * The standard events in the Document Object Model are: `blur`, `focus`, `load`, `resize`, `scroll`, `unload`, `beforeunload`, `click`, `dblclick`, `mousedown`, `mouseup`, `mousemove`, `mouseover`, `mouseout`, `mouseenter`, `mouseleave`, `change`, `select`, `submit`, `keydown`, `keypress`, and `keyup`. Since the DOM event names have predefined meanings for some elements, using them for other purposes is not recommended. jQuery's event model can trigger an event by any name on an element, and it is propagated up the DOM tree to which that element belongs, if any. * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` * @see \`{@link TriggeredEvent }\` */ interface Event { // region Copied properties // #region Copied properties // Event bubbles: boolean | undefined; cancelable: boolean | undefined; eventPhase: number | undefined; // UIEvent detail: number | undefined; view: Window | undefined; // MouseEvent button: number | undefined; buttons: number | undefined; clientX: number | undefined; clientY: number | undefined; offsetX: number | undefined; offsetY: number | undefined; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: number | undefined; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: number | undefined; screenX: number | undefined; screenY: number | undefined; /** @deprecated */ toElement: Element | undefined; // PointerEvent pointerId: number | undefined; pointerType: string | undefined; // KeyboardEvent /** @deprecated */ char: string | undefined; /** @deprecated */ charCode: number | undefined; key: string | undefined; /** @deprecated */ keyCode: number | undefined; // TouchEvent changedTouches: TouchList | undefined; targetTouches: TouchList | undefined; touches: TouchList | undefined; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: number | undefined; // MouseEvent, KeyboardEvent, TouchEvent altKey: boolean | undefined; ctrlKey: boolean | undefined; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: boolean | undefined; shiftKey: boolean | undefined; // #endregion /** * The difference in milliseconds between the time the browser created the event and January 1, 1970. * @see \`{@link https://api.jquery.com/event.timeStamp/ }\` * @since 1.2.6 * @example ​ ````Display the time since the click handler last executed. ```html event.timeStamp demo
      Click.
      ​ ``` */ timeStamp: number; /** * Describes the nature of the event. * @see \`{@link https://api.jquery.com/event.type/ }\` * @since 1.0 * @example ​ ````On all anchor clicks, alert the event type. ```javascript $( "a" ).click(function( event ) { alert( event.type ); // "click" }); ``` */ type: string; /** * Returns whether event.preventDefault() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isDefaultPrevented/ }\` * @since 1.3 * @example ​ ````Checks whether event.preventDefault() was called. ```javascript $( "a" ).click(function( event ) { alert( event.isDefaultPrevented() ); // false event.preventDefault(); alert( event.isDefaultPrevented() ); // true }); ``` */ isDefaultPrevented(): boolean; /** * Returns whether event.stopImmediatePropagation() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isImmediatePropagationStopped/ }\` * @since 1.3 * @example ​ ````Checks whether event.stopImmediatePropagation() was called. ```html event.isImmediatePropagationStopped demo
      ​ ``` */ isImmediatePropagationStopped(): boolean; /** * Returns whether event.stopPropagation() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isPropagationStopped/ }\` * @since 1.3 * @example ​ ````Checks whether event.stopPropagation() was called ```html event.isPropagationStopped demo
      ​ ``` */ isPropagationStopped(): boolean; /** * If this method is called, the default action of the event will not be triggered. * @see \`{@link https://api.jquery.com/event.preventDefault/ }\` * @since 1.0 * @example ​ ````Cancel the default action (navigation) of the click. ```html event.preventDefault demo default click action is prevented
      ​ ``` */ preventDefault(): void; /** * Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree. * @see \`{@link https://api.jquery.com/event.stopImmediatePropagation/ }\` * @since 1.3 * @example ​ ````Prevents other event handlers from being called. ```html event.stopImmediatePropagation demo

      paragraph

      division
      ​ ``` */ stopImmediatePropagation(): void; /** * Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event. * @see \`{@link https://api.jquery.com/event.stopPropagation/ }\` * @since 1.0 * @example ​ ````Kill the bubbling on the click event. ```javascript $( "p" ).click(function( event ) { event.stopPropagation(); // Do something }); ``` */ stopPropagation(): void; } // #endregion /** * Base type for jQuery events that have been triggered (including events triggered on plain objects). */ interface TriggeredEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends Event { /** * The current DOM element within the event bubbling phase. * @see \`{@link https://api.jquery.com/event.currentTarget/ }\` * @since 1.3 * @example ​ ````Alert that currentTarget matches the `this` keyword. ```javascript $( "p" ).click(function( event ) { alert( event.currentTarget === this ); // true }); ``` */ currentTarget: TCurrentTarget; /** * The element where the currently-called jQuery event handler was attached. * @see \`{@link https://api.jquery.com/event.delegateTarget/ }\` * @since 1.7 * @example ​ ````When a button in any box class is clicked, change the box's background color to red. ```javascript $( ".box" ).on( "click", "button", function( event ) { $( event.delegateTarget ).css( "background-color", "red" ); }); ``` */ delegateTarget: TDelegateTarget; /** * The DOM element that initiated the event. * @see \`{@link https://api.jquery.com/event.target/ }\` * @since 1.0 * @example ​ ````Display the tag's name on click ```html event.target demo

      click

      ​ ``` * @example ​ ````Implements a simple event delegation: The click handler is added to an unordered list, and the children of its li children are hidden. Clicking one of the li children toggles (see toggle()) their children. ```html event.target demo
      • item 1
        • sub item 1-a
        • sub item 1-b
      • item 2
        • sub item 2-a
        • sub item 2-b
      ​ ``` */ target: TTarget; /** * An optional object of data passed to an event method when the current executing handler is bound. * @see \`{@link https://api.jquery.com/event.data/ }\` * @since 1.1 * @example ​ ````Within a for loop, pass the value of i to the .on() method so that the current iteration's value is preserved. ```html event.data demo
      ​ ``` */ data: TData; /** * The namespace specified when the event was triggered. * @see \`{@link https://api.jquery.com/event.namespace/ }\` * @since 1.4.3 * @example ​ ````Determine the event namespace used. ```html event.namespace demo

      ​ ``` */ namespace?: string; originalEvent?: _Event; /** * The last value returned by an event handler that was triggered by this event, unless the value was undefined. * @see \`{@link https://api.jquery.com/event.result/ }\` * @since 1.3 * @example ​ ````Display previous handler's return value ```html event.result demo

      ​ ``` */ result?: any; } // region Event // #region Event interface EventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TriggeredEvent { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: undefined; // Event bubbles: boolean; cancelable: boolean; eventPhase: number; // UIEvent detail: undefined; view: undefined; // MouseEvent button: undefined; buttons: undefined; clientX: undefined; clientY: undefined; offsetX: undefined; offsetY: undefined; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: undefined; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: undefined; screenX: undefined; screenY: undefined; /** @deprecated */ toElement: undefined; // PointerEvent pointerId: undefined; pointerType: undefined; // KeyboardEvent /** @deprecated */ char: undefined; /** @deprecated */ charCode: undefined; key: undefined; /** @deprecated */ keyCode: undefined; // TouchEvent changedTouches: undefined; targetTouches: undefined; touches: undefined; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`. * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: undefined; // MouseEvent, KeyboardEvent, TouchEvent altKey: undefined; ctrlKey: undefined; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: undefined; shiftKey: undefined; originalEvent?: _Event; } interface ChangeEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends EventBase { type: 'change'; } interface ResizeEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends EventBase { type: 'resize'; } interface ScrollEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends EventBase { type: 'scroll'; } interface SelectEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends EventBase { type: 'select'; } interface SubmitEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends EventBase { type: 'submit'; } // #endregion // region UIEvent // #region UIEvent interface UIEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TriggeredEvent { // Event bubbles: boolean; cancelable: boolean; eventPhase: number; // UIEvent detail: number; view: Window; originalEvent?: _UIEvent; } // region MouseEvent // #region MouseEvent interface MouseEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends UIEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: EventTarget | null; // MouseEvent button: number; buttons: number; clientX: number; clientY: number; offsetX: number; offsetY: number; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: number; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: number; screenX: number; screenY: number; /** @deprecated */ toElement: Element; // PointerEvent pointerId: undefined; pointerType: undefined; // KeyboardEvent /** @deprecated */ char: undefined; /** @deprecated */ charCode: undefined; key: undefined; /** @deprecated */ keyCode: undefined; // TouchEvent changedTouches: undefined; targetTouches: undefined; touches: undefined; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`. * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: number; // MouseEvent, KeyboardEvent, TouchEvent altKey: boolean; ctrlKey: boolean; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: boolean; shiftKey: boolean; originalEvent?: _MouseEvent; } interface ClickEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'click'; } interface ContextMenuEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'contextmenu'; } interface DoubleClickEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'dblclick'; } interface MouseDownEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'mousedown'; } interface MouseEnterEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { // Special handling by jQuery. type: 'mouseover'; } interface MouseLeaveEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { // Special handling by jQuery. type: 'mouseout'; } interface MouseMoveEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'mousemove'; } interface MouseOutEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { type: 'mouseout'; } interface MouseOverEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { type: 'mouseover'; } interface MouseUpEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends MouseEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: null; type: 'mouseup'; } // region DragEvent // #region DragEvent interface DragEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends UIEventBase { originalEvent?: _DragEvent; } interface DragEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'drag'; } interface DragEndEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragend'; } interface DragEnterEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragenter'; } interface DragExitEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragexit'; } interface DragLeaveEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragleave'; } interface DragOverEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragover'; } interface DragStartEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'dragstart'; } interface DropEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends DragEventBase { type: 'drop'; } // #endregion // #endregion // region KeyboardEvent // #region KeyboardEvent interface KeyboardEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends UIEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: undefined; // MouseEvent button: undefined; buttons: undefined; clientX: undefined; clientY: undefined; offsetX: undefined; offsetY: undefined; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: undefined; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: undefined; screenX: undefined; screenY: undefined; /** @deprecated */ toElement: undefined; // PointerEvent pointerId: undefined; pointerType: undefined; // KeyboardEvent /** @deprecated */ char: string | undefined; /** @deprecated */ charCode: number; code: string; key: string; /** @deprecated */ keyCode: number; // TouchEvent changedTouches: undefined; targetTouches: undefined; touches: undefined; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`. * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: number; // MouseEvent, KeyboardEvent, TouchEvent altKey: boolean; ctrlKey: boolean; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: boolean; shiftKey: boolean; originalEvent?: _KeyboardEvent; } interface KeyDownEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends KeyboardEventBase { type: 'keydown'; } interface KeyPressEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends KeyboardEventBase { type: 'keypress'; } interface KeyUpEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends KeyboardEventBase { type: 'keyup'; } // #endregion // region TouchEvent // #region TouchEvent interface TouchEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends UIEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: undefined; // MouseEvent button: undefined; buttons: undefined; clientX: undefined; clientY: undefined; offsetX: undefined; offsetY: undefined; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: undefined; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: undefined; screenX: undefined; screenY: undefined; /** @deprecated */ toElement: undefined; // PointerEvent pointerId: undefined; pointerType: undefined; // KeyboardEvent /** @deprecated */ char: undefined; /** @deprecated */ charCode: undefined; key: undefined; /** @deprecated */ keyCode: undefined; // TouchEvent changedTouches: TouchList; targetTouches: TouchList; touches: TouchList; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`. * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: undefined; // MouseEvent, KeyboardEvent, TouchEvent altKey: boolean; ctrlKey: boolean; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: boolean; shiftKey: boolean; originalEvent?: _TouchEvent; } interface TouchCancelEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TouchEventBase { type: 'touchcancel'; } interface TouchEndEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TouchEventBase { type: 'touchend'; } interface TouchMoveEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TouchEventBase { type: 'touchmove'; } interface TouchStartEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends TouchEventBase { type: 'touchstart'; } // #endregion // region FocusEvent // #region FocusEvent interface FocusEventBase< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends UIEventBase { /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 * @example ​ ````On mouseout of anchors, alert the element type being entered. ```javascript $( "a" ).mouseout(function( event ) { alert( event.relatedTarget.nodeName ); // "DIV" }); ``` */ relatedTarget?: EventTarget | null; // MouseEvent button: undefined; buttons: undefined; clientX: undefined; clientY: undefined; offsetX: undefined; offsetY: undefined; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageX demo
      ​ ``` */ pageX: undefined; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 * @example ​ ````Show the mouse position relative to the left and top edges of the document (within this iframe). ```html event.pageY demo
      ​ ``` */ pageY: undefined; screenX: undefined; screenY: undefined; /** @deprecated */ toElement: undefined; // PointerEvent pointerId: undefined; pointerType: undefined; // KeyboardEvent /** @deprecated */ char: undefined; /** @deprecated */ charCode: undefined; key: undefined; /** @deprecated */ keyCode: undefined; // TouchEvent changedTouches: undefined; targetTouches: undefined; touches: undefined; // MouseEvent, KeyboardEvent /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 * @deprecated ​ Deprecated since 3.3. See \`{@link https://github.com/jquery/api.jquery.com/issues/821 }\`. * @example ​ ````Log which key was depressed. ```html event.which demo
      ​ ``` * @example ​ ````Log which mouse button was depressed. ```html event.which demo
      ​ ``` */ which: undefined; // MouseEvent, KeyboardEvent, TouchEvent altKey: undefined; ctrlKey: undefined; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 * @example ​ ````Determine whether the META key was pressed when the event fired. ```html event.metaKey demo
      ​ ``` */ metaKey: undefined; shiftKey: undefined; originalEvent?: _FocusEvent; } interface BlurEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends FocusEventBase { type: 'blur'; } interface FocusEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends FocusEventBase { type: 'focus'; } interface FocusInEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends FocusEventBase { type: 'focusin'; } interface FocusOutEvent< TDelegateTarget = any, TData = any, TCurrentTarget = any, TTarget = any > extends FocusEventBase { type: 'focusout'; } // #endregion // #endregion interface TypeToTriggeredEventMap< TDelegateTarget, TData, TCurrentTarget, TTarget > { // Event change: ChangeEvent; resize: ResizeEvent; scroll: ScrollEvent; select: SelectEvent; submit: SubmitEvent; // UIEvent // MouseEvent click: ClickEvent; contextmenu: ContextMenuEvent; dblclick: DoubleClickEvent; mousedown: MouseDownEvent; mouseenter: MouseEnterEvent; mouseleave: MouseLeaveEvent; mousemove: MouseMoveEvent; mouseout: MouseOutEvent; mouseover: MouseOverEvent; mouseup: MouseUpEvent; // DragEvent drag: DragEvent; dragend: DragEndEvent; dragenter: DragEnterEvent; dragexit: DragExitEvent; dragleave: DragLeaveEvent; dragover: DragOverEvent; dragstart: DragStartEvent; drop: DropEvent; // KeyboardEvent keydown: KeyDownEvent; keypress: KeyPressEvent; keyup: KeyUpEvent; // TouchEvent touchcancel: TouchCancelEvent; touchend: TouchEndEvent; touchmove: TouchMoveEvent; touchstart: TouchStartEvent; // FocusEvent blur: BlurEvent; focus: FocusEvent; focusin: FocusInEvent; focusout: FocusOutEvent; [type: string]: TriggeredEvent; } // Extra parameters can be passed from trigger() type EventHandlerBase = (this: TContext, t: T, ...args: any[]) => any; type EventHandler< TCurrentTarget, TData = undefined > = EventHandlerBase>; type TypeEventHandler< TDelegateTarget, TData, TCurrentTarget, TTarget, TType extends keyof TypeToTriggeredEventMap > = EventHandlerBase[TType]>; interface TypeEventHandlers< TDelegateTarget, TData, TCurrentTarget, TTarget > extends _TypeEventHandlers { // No idea why it's necessary to include `object` in the union but otherwise TypeScript complains that // derived types of Event are not assignable to Event. [type: string]: TypeEventHandler | false | undefined | object; } type _TypeEventHandlers< TDelegateTarget, TData, TCurrentTarget, TTarget > = { [TType in keyof TypeToTriggeredEventMap]?: TypeEventHandler | false | object; }; // region Event extensions // #region Event extensions interface EventExtensions { /** * The jQuery special event hooks are a set of per-event-name functions and properties that allow code to control the behavior of event processing within jQuery. The mechanism is similar to `fixHooks` in that the special event information is stored in `jQuery.event.special.NAME`, where `NAME` is the name of the special event. Event names are case sensitive. * * As with `fixHooks`, the special event hooks design assumes it will be very rare that two unrelated pieces of code want to process the same event name. Special event authors who need to modify events with existing hooks will need to take precautions to avoid introducing unwanted side-effects by clobbering those hooks. * @see \`{@link https://learn.jquery.com/events/event-extensions/#special-event-hooks }\` */ special: SpecialEventHooks; } // region Special event hooks // #region Special event hooks /** * The jQuery special event hooks are a set of per-event-name functions and properties that allow code to control the behavior of event processing within jQuery. The mechanism is similar to `fixHooks` in that the special event information is stored in `jQuery.event.special.NAME`, where `NAME` is the name of the special event. Event names are case sensitive. * * As with `fixHooks`, the special event hooks design assumes it will be very rare that two unrelated pieces of code want to process the same event name. Special event authors who need to modify events with existing hooks will need to take precautions to avoid introducing unwanted side-effects by clobbering those hooks. * @see \`{@link https://learn.jquery.com/events/event-extensions/#special-event-hooks }\` */ // Workaround for TypeScript 2.3 which does not have support for weak types handling. type SpecialEventHook = { /** * Indicates whether this event type should be bubbled when the `.trigger()` method is called; by default it is `false`, meaning that a triggered event will bubble to the element's parents up to the document (if attached to a document) and then to the window. Note that defining `noBubble` on an event will effectively prevent that event from being used for delegated events with `.trigger()`. * @see \`{@link https://learn.jquery.com/events/event-extensions/#nobubble-boolean }\` */ noBubble: boolean; } | { /** * When defined, these string properties specify that a special event should be handled like another event type until the event is delivered. The `bindType` is used if the event is attached directly, and the `delegateType` is used for delegated events. These types are generally DOM event types, and _should not_ be a special event themselves. * @see \`{@link https://learn.jquery.com/events/event-extensions/#bindtype-string-delegatetype-string }\` */ bindType: string; } | { /** * When defined, these string properties specify that a special event should be handled like another event type until the event is delivered. The `bindType` is used if the event is attached directly, and the `delegateType` is used for delegated events. These types are generally DOM event types, and _should not_ be a special event themselves. * @see \`{@link https://learn.jquery.com/events/event-extensions/#bindtype-string-delegatetype-string }\` */ delegateType: string; } | { /** * The setup hook is called the first time an event of a particular type is attached to an element; this provides the hook an opportunity to do processing that will apply to all events of this type on this element. The `this` keyword will be a reference to the element where the event is being attached and `eventHandle` is jQuery's event handler function. In most cases the `namespaces` argument should not be used, since it only represents the namespaces of the _first_ event being attached; subsequent events may not have this same namespaces. * * This hook can perform whatever processing it desires, including attaching its own event handlers to the element or to other elements and recording setup information on the element using the `jQuery.data()` method. If the setup hook wants jQuery to add a browser event (via `addEventListener` or `attachEvent`, depending on browser) it should return `false`. In all other cases, jQuery will not add the browser event, but will continue all its other bookkeeping for the event. This would be appropriate, for example, if the event was never fired by the browser but invoked by `.trigger()`. To attach the jQuery event handler in the setup hook, use the `eventHandle` argument. * @see \`{@link https://learn.jquery.com/events/event-extensions/#setup-function-data-object-namespaces-eventhandle-function }\` */ setup(this: TTarget, data: TData, namespaces: string, eventHandle: EventHandler): void | false; } | { /** * The teardown hook is called when the final event of a particular type is removed from an element. The `this` keyword will be a reference to the element where the event is being cleaned up. This hook should return `false` if it wants jQuery to remove the event from the browser's event system (via `removeEventListener` or `detachEvent`). In most cases, the setup and teardown hooks should return the same value. * * If the setup hook attached event handlers or added data to an element through a mechanism such as `jQuery.data()`, the teardown hook should reverse the process and remove them. jQuery will generally remove the data and events when an element is totally removed from the document, but failing to remove data or events on teardown will cause a memory leak if the element stays in the document. * @see \`{@link https://learn.jquery.com/events/event-extensions/#teardown-function }\` */ teardown(this: TTarget): void | false; } | { /** * Each time an event handler is added to an element through an API such as `.on()`, jQuery calls this hook. The `this` keyword will be the element to which the event handler is being added, and the `handleObj` argument is as described in the section above. The return value of this hook is ignored. * @see \`{@link https://learn.jquery.com/events/event-extensions/#add-function-handleobj }\` */ add(this: TTarget, handleObj: HandleObject): void; } | { /** * When an event handler is removed from an element using an API such as `.off()`, this hook is called. The `this` keyword will be the element where the handler is being removed, and the `handleObj` argument is as described in the section above. The return value of this hook is ignored. * @see \`{@link https://learn.jquery.com/events/event-extensions/#remove-function-handleobj }\` */ remove(this: TTarget, handleObj: HandleObject): void; } | { /** * Called when the `.trigger()` or `.triggerHandler()` methods are used to trigger an event for the special type from code, as opposed to events that originate from within the browser. The `this` keyword will be the element being triggered, and the event argument will be a `jQuery.Event` object constructed from the caller's input. At minimum, the event type, data, namespace, and target properties are set on the event. The data argument represents additional data passed by `.trigger()` if present. * * The trigger hook is called early in the process of triggering an event, just after the `jQuery.Event` object is constructed and before any handlers have been called. It can process the triggered event in any way, for example by calling `event.stopPropagation()` or `event.preventDefault()` before returning. If the hook returns `false`, jQuery does not perform any further event triggering actions and returns immediately. Otherwise, it performs the normal trigger processing, calling any event handlers for the element and bubbling the event (unless propagation is stopped in advance or `noBubble` was specified for the special event) to call event handlers attached to parent elements. * @see \`{@link https://learn.jquery.com/events/event-extensions/#trigger-function-event-jquery-event-data-object }\` */ trigger(this: TTarget, event: Event, data: TData): void | false; } | { /** * When the `.trigger()` method finishes running all the event handlers for an event, it also looks for and runs any method on the target object by the same name unless of the handlers called `event.preventDefault()`. So, `.trigger( "submit" )` will execute the `submit()` method on the element if one exists. When a `_default` hook is specified, the hook is called just prior to checking for and executing the element's default method. If this hook returns the value `false` the element's default method will be called; otherwise it is not. * @see \`{@link https://learn.jquery.com/events/event-extensions/#_default-function-event-jquery-event-data-object }\` */ _default(event: TriggeredEvent, data: TData): void | false; } | { /** * jQuery calls a handle hook when the event has occurred and jQuery would normally call the user's event handler specified by `.on()` or another event binding method. If the hook exists, jQuery calls it _instead_ of that event handler, passing it the event and any data passed from `.trigger()` if it was not a native event. The `this` keyword is the DOM element being handled, and `event.handleObj` property has the detailed event information. * * Based in the information it has, the handle hook should decide whether to call the original handler function which is in `event.handleObj.handler`. It can modify information in the event object before calling the original handler, but _must restore_ that data before returning or subsequent unrelated event handlers may act unpredictably. In most cases, the handle hook should return the result of the original handler, but that is at the discretion of the hook. The handle hook is unique in that it is the only special event function hook that is called under its original special event name when the type is mapped using `bindType` and `delegateType`. For that reason, it is almost always an error to have anything other than a handle hook present if the special event defines a `bindType` and `delegateType`, since those other hooks will never be called. * @see \`{@link https://learn.jquery.com/events/event-extensions/#handle-function-event-jquery-event-data-object }\` */ handle(this: TTarget, event: TriggeredEvent & { handleObj: HandleObject; }, ...data: TData[]): void; } | { preDispatch(this: TTarget, event: Event): false | void; } | { postDispatch(this: TTarget, event: Event): void; } | { [key: string]: never; }; interface SpecialEventHooks { [event: string]: SpecialEventHook; } /** * Many of the special event hook functions below are passed a `handleObj` object that provides more information about the event, how it was attached, and its current state. This object and its contents should be treated as read-only data, and only the properties below are documented for use by special event handlers. * @see \`{@link https://learn.jquery.com/events/event-extensions/#the-handleobj-object }\` */ interface HandleObject { /** * The type of event, such as `"click"`. When special event mapping is used via `bindType` or `delegateType`, this will be the mapped type. */ readonly type: string; /** * The original type name regardless of whether it was mapped via `bindType` or `delegateType`. So when a "pushy" event is mapped to "click" its `origType` would be "pushy". */ readonly origType: string; /** * Namespace(s), if any, provided when the event was attached, such as `"myPlugin"`. When multiple namespaces are given, they are separated by periods and sorted in ascending alphabetical order. If no namespaces are provided, this property is an empty string. */ readonly namespace: string; /** * For delegated events, this is the selector used to filter descendant elements and determine if the handler should be called. For directly bound events, this property is `null`. */ readonly selector: string | undefined | null; /** * The data, if any, passed to jQuery during event binding, e.g. `{ myData: 42 }`. If the data argument was omitted or `undefined`, this property is `undefined` as well. */ readonly data: TData; /** * Event handler function passed to jQuery during event binding. If `false` was passed during event binding, the handler refers to a single shared function that simply returns `false`. */ readonly handler: EventHandler; } // #endregion // #endregion // #endregion interface NameValuePair { name: string; value: string; } // region Coordinates // #region Coordinates interface Coordinates { left: number; top: number; } // Workaround for TypeScript 2.3 which does not have support for weak types handling. type CoordinatesPartial = Pick | Pick | { [key: string]: never; }; // #endregion // region Val hooks // #region Val hooks // Workaround for TypeScript 2.3 which does not have support for weak types handling. type ValHook = { get(elem: TElement): any; } | { set(elem: TElement, value: any): any; } | { [key: string]: never; }; interface ValHooks { // Set to HTMLElement to minimize breaks but should probably be Element. [nodeName: string]: ValHook; } // #endregion type _Falsy = false | null | undefined | 0 | '' | typeof document.all; } declare const jQuery: JQueryStatic; declare const $: JQueryStatic; type _Event = Event; type _UIEvent = UIEvent; type _MouseEvent = MouseEvent; type _DragEvent = DragEvent; type _KeyboardEvent = KeyboardEvent; type _TouchEvent = TouchEvent; type _FocusEvent = FocusEvent; // region ES5 compatibility // #region ES5 compatibility // Forward declaration of `Iterable`. // tslint:disable-next-line:no-empty-interface interface Iterable { } interface SymbolConstructor { /** * A String value that is used in the creation of the default string description of an object. * Called by the built-in method Object.prototype.toString. */ readonly toStringTag: symbol; } declare var Symbol: SymbolConstructor; // #endregion // tslint:disable:no-irregular-whitespace // tslint:disable-next-line:no-empty-interface interface JQueryCallback extends JQuery.Callbacks { } interface JQueryDeferred extends JQuery.Deferred { } // tslint:disable-next-line:no-empty-interface interface JQueryEventConstructor extends JQuery.EventStatic { } interface JQueryDeferred extends JQuery.Deferred { } // tslint:disable-next-line:no-empty-interface interface JQueryAjaxSettings extends JQuery.AjaxSettings { } interface JQueryAnimationOptions extends JQuery.EffectsOptions { } // tslint:disable-next-line:no-empty-interface interface JQueryCoordinates extends JQuery.Coordinates { } interface JQueryGenericPromise extends JQuery.Thenable { } // tslint:disable-next-line:no-empty-interface interface JQueryXHR extends JQuery.jqXHR { } interface JQueryPromise extends JQuery.Promise { } // tslint:disable-next-line:no-empty-interface interface JQuerySerializeArrayElement extends JQuery.NameValuePair { } /** * @deprecated ​ Deprecated since 1.9. See \`{@link https://api.jquery.com/jQuery.support/ }\`. */ // tslint:disable-next-line:no-empty-interface interface JQuerySupport extends JQuery.PlainObject { } // Legacy types that are not represented in the current type definitions are marked deprecated. /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Deferred.Callback }\` or \`{@link JQuery.Deferred.CallbackBase }\`. */ interface JQueryPromiseCallback { (value?: T, ...args: any[]): void; } /** * @deprecated ​ Deprecated. Use \`{@link JQueryStatic.param JQueryStatic['param']}\`. */ interface JQueryParam { /** * Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request. * @param obj An array or object to serialize. * @param traditional A Boolean indicating whether to perform a traditional "shallow" serialization. */ (obj: any, traditional?: boolean): string; } /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\`. */ interface BaseJQueryEventObject extends Event { /** * The current DOM element within the event bubbling phase. * @see \`{@link https://api.jquery.com/event.currentTarget/ }\` */ currentTarget: Element; /** * An optional object of data passed to an event method when the current executing handler is bound. * @see \`{@link https://api.jquery.com/event.data/ }\` */ data: any; /** * The element where the currently-called jQuery event handler was attached. * @see \`{@link https://api.jquery.com/event.delegateTarget/ }\` */ delegateTarget: Element; /** * Returns whether event.preventDefault() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isDefaultPrevented/ }\` */ isDefaultPrevented(): boolean; /** * Returns whether event.stopImmediatePropagation() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isImmediatePropagationStopped/ }\` */ isImmediatePropagationStopped(): boolean; /** * Returns whether event.stopPropagation() was ever called on this event object. * @see \`{@link https://api.jquery.com/event.isPropagationStopped/ }\` */ isPropagationStopped(): boolean; /** * The namespace specified when the event was triggered. * @see \`{@link https://api.jquery.com/event.namespace/ }\` */ namespace: string; /** * The browser's original Event object. * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` */ originalEvent: Event; /** * If this method is called, the default action of the event will not be triggered. * @see \`{@link https://api.jquery.com/event.preventDefault/ }\` */ preventDefault(): any; /** * The other DOM element involved in the event, if any. * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` */ relatedTarget: Element; /** * The last value returned by an event handler that was triggered by this event, unless the value was undefined. * @see \`{@link https://api.jquery.com/event.result/ }\` */ result: any; /** * Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree. * @see \`{@link https://api.jquery.com/event.stopImmediatePropagation/ }\` */ stopImmediatePropagation(): void; /** * Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event. * @see \`{@link https://api.jquery.com/event.stopPropagation/ }\` */ stopPropagation(): void; /** * The DOM element that initiated the event. * @see \`{@link https://api.jquery.com/event.target/ }\` */ target: Element; /** * The mouse position relative to the left edge of the document. * @see \`{@link https://api.jquery.com/event.pageX/ }\` */ pageX: number; /** * The mouse position relative to the top edge of the document. * @see \`{@link https://api.jquery.com/event.pageY/ }\` */ pageY: number; /** * For key or mouse events, this property indicates the specific key or button that was pressed. * @see \`{@link https://api.jquery.com/event.which/ }\` */ which: number; /** * Indicates whether the META key was pressed when the event fired. * @see \`{@link https://api.jquery.com/event.metaKey/ }\` */ metaKey: boolean; } /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\`. */ interface JQueryInputEventObject extends BaseJQueryEventObject { altKey: boolean; ctrlKey: boolean; metaKey: boolean; shiftKey: boolean; } /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\`. */ interface JQueryMouseEventObject extends JQueryInputEventObject { button: number; clientX: number; clientY: number; offsetX: number; offsetY: number; pageX: number; pageY: number; screenX: number; screenY: number; } /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\`. */ interface JQueryKeyEventObject extends JQueryInputEventObject { /** @deprecated */ char: string; /** @deprecated */ charCode: number; key: string; /** @deprecated */ keyCode: number; } /** * @deprecated ​ Deprecated. Use \`{@link JQuery.Event }\`. */ interface JQueryEventObject extends BaseJQueryEventObject, JQueryInputEventObject, JQueryMouseEventObject, JQueryKeyEventObject { } /** * @deprecated ​ Deprecated. */ interface JQueryPromiseOperator { (callback1: JQuery.TypeOrArray>, ...callbacksN: Array>>): JQueryPromise; } /** * @deprecated ​ Deprecated. Internal. See \`{@link https://github.com/jquery/api.jquery.com/issues/912 }\`. */ interface JQueryEasingFunction { (percent: number): number; } /** * @deprecated ​ Deprecated. Internal. See \`{@link https://github.com/jquery/api.jquery.com/issues/912 }\`. */ interface JQueryEasingFunctions { [name: string]: JQueryEasingFunction; linear: JQueryEasingFunction; swing: JQueryEasingFunction; }