[jquery] Accept Document, Window, and JQuery.PlainObject for th…

…e `element` parameter of Data APIs. See https://github.com/jquery/jquery/blob/354f6036f251a3ce9b24cd7b228b4c7a79001520/test/unit/data.js#L142-L164 and jquery/api.jquery.com#1035.
leonard-thieu · Oct 9, 2018 · cf0be56 · cf0be56
1 parent 8310859
commit cf0be56
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 13 deletions.
diff --git a/types/jquery/index.d.ts b/types/jquery/index.d.ts
@@ -475,7 +475,7 @@ $( "button" ).click( function() {
 </html>
 ```
      */
-    data<T extends string | number | boolean | symbol | object | null>(element: Element, key: string, value: T): T;
+    data<T extends string | number | boolean | symbol | object | null>(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.
@@ -490,7 +490,7 @@ $( "button" ).click( function() {
     // `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, key: string, value: undefined): any;
+    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.
@@ -540,7 +540,7 @@ $( "span:last" ).text( jQuery.data( div, "test" ).last );
 </html>
 ```
      */
-    data(element: Element, key?: string): any;
+    data(element: Element | Document | Window | JQuery.PlainObject, key?: string): any;
     /**
      * Execute the next function on the queue for the matched element.
      *
@@ -1976,7 +1976,7 @@ $p.append( jQuery.hasData( p ) + " " ); // false
 </html>
 ```
      */
-    hasData(element: Element): boolean;
+    hasData(element: Element | Document | Window | JQuery.PlainObject): boolean;
     /**
      * Holds or releases the execution of jQuery's ready event.
      *
@@ -12944,7 +12944,7 @@ $( "span:eq(3)" ).text( "" + jQuery.data( div, "test2" ) );
 </html>
 ```
      */
-    removeData(element: Element, name?: string): void;
+    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.
      *

diff --git a/types/jquery/jquery-tests.ts b/types/jquery/jquery-tests.ts
@@ -284,21 +284,23 @@ function JQueryStatic() {
     }
 
     function data() {
+        const element: Element | Document | Window | JQuery.PlainObject = {} as any;
+
         const value: string | undefined = {} as any;
         // $ExpectError
-        $.data(new HTMLElement(), 'myKey', value);
+        $.data(element, 'myKey', value);
 
         // $ExpectType "myValue"
-        $.data(new HTMLElement(), 'myKey', 'myValue');
+        $.data(element, 'myKey', 'myValue');
 
         // $ExpectType any
-        $.data(new HTMLElement(), 'myKey', undefined);
+        $.data(element, 'myKey', undefined);
 
         // $ExpectType any
-        $.data(new HTMLElement(), 'myKey');
+        $.data(element, 'myKey');
 
         // $ExpectType any
-        $.data(new HTMLElement());
+        $.data(element);
     }
 
     function dequeue() {
@@ -611,8 +613,10 @@ function JQueryStatic() {
     }
 
     function hasData() {
+        const element: Element | Document | Window | JQuery.PlainObject = {} as any;
+
         // $ExpectType boolean
-        $.hasData(new HTMLElement());
+        $.hasData(element);
     }
 
     function holdReady() {
@@ -1731,11 +1735,13 @@ function JQueryStatic() {
     }
 
     function removeData() {
+        const element: Element | Document | Window | JQuery.PlainObject = {} as any;
+
         // $ExpectType void
-        $.removeData(new HTMLElement(), 'test1');
+        $.removeData(element, 'test1');
 
         // $ExpectType void
-        $.removeData(new HTMLElement());
+        $.removeData(element);
     }
 
     function speed() {