Improved types

fabiospampinato · fabiospampinato · commit fed591fa0039 · 2019-12-17T04:54:36.000Z
diff --git a/src/attributes/attr.ts b/src/attributes/attr.ts
@@ -8,14 +8,14 @@ interface Cash {
   attr (): undefined;
   attr ( attrs: string ): string | null;
   attr ( attrs: string, value: string ): this;
-  attr ( attrs: plainObject ): this;
+  attr ( attrs: Record<string, string> ): this;
 }
 
 function attr ( this: Cash ): undefined;
 function attr ( this: Cash, attr: string ): string | null;
 function attr ( this: Cash, attr: string, value: string ): Cash;
-function attr ( this: Cash, attr: plainObject ): Cash;
-function attr ( this: Cash, attr?: string | plainObject, value?: string ) {
+function attr ( this: Cash, attr: Record<string, string> ): Cash;
+function attr ( this: Cash, attr?: string | Record<string, string>, value?: string ) {
 
   if ( !attr ) return;
 
diff --git a/src/attributes/has_class.ts b/src/attributes/has_class.ts
@@ -9,6 +9,6 @@ interface Cash {
 
 fn.hasClass = function ( this: Cash, cls: string ) {
 
-  return !!cls && some.call ( this, ( ele: Ele ) => ele.classList.contains ( cls ) );
+  return !!cls && some.call ( this, ( ele: EleLoose ) => ele.classList.contains ( cls ) );
 
 };
diff --git a/src/attributes/prop.ts b/src/attributes/prop.ts
@@ -6,10 +6,10 @@
 interface Cash {
   prop ( prop: string ): any;
   prop ( prop: string, value: any ): this;
-  prop ( props: plainObject ): this;
+  prop ( props: Record<string, any> ): this;
 }
 
-fn.prop = function ( this: Cash, prop: string | plainObject, value?: any ) {
+fn.prop = function ( this: Cash, prop: string | Record<string, any>, value?: any ) {
 
   if ( !prop ) return;
 
diff --git a/src/collection/filter.ts b/src/collection/filter.ts
@@ -13,6 +13,6 @@ fn.filter = function ( this: Cash, comparator?: Comparator ) {
 
   const compare = getCompareFunction ( comparator );
 
-  return cash ( filter.call ( this, ( ele: Ele, i: number ) => compare.call ( ele, i, ele ) ) );
+  return cash ( filter.call ( this, ( ele: EleLoose, i: number ) => compare.call ( ele, i, ele ) ) );
 
 };
diff --git a/src/collection/map.ts b/src/collection/map.ts
@@ -10,6 +10,6 @@ interface Cash {
 
 fn.map = function ( this: Cash, callback: MapCallback<EleLoose> ) {
 
-  return cash ( map.call ( this, ( ele: Ele, i: number ) => callback.call ( ele, i, ele ) ) );
+  return cash ( map.call ( this, ( ele: EleLoose, i: number ) => callback.call ( ele, i, ele ) ) );
 
 };
diff --git a/src/core/each.ts b/src/core/each.ts
@@ -7,7 +7,7 @@ interface CashStatic {
   each<T> ( arr: ArrayLike<T>, callback: EachCallback<T> ): void;
 }
 
-function each<T> ( arr: ArrayLike<T>, callback: EachCallback<T>, reverse?: boolean ): ArrayLike<T> { //TODO: Maybe add a flag for looping in reverse
+function each<T, U extends ArrayLike<T> = ArrayLike<T>> ( arr: U, callback: EachCallback<U[0]>, reverse?: boolean ): U {
 
   if ( reverse ) {
 
diff --git a/src/core/extend.ts b/src/core/extend.ts
@@ -6,7 +6,7 @@ interface CashStatic {
 }
 
 interface Cash {
-  extend ( plugins: plainObject ): this;
+  extend ( plugins: Record<any, any> ): this;
 }
 
 cash.extend = function ( target: any, ...objs: any[] ) {
@@ -27,7 +27,7 @@ cash.extend = function ( target: any, ...objs: any[] ) {
 
 };
 
-fn.extend = function ( plugins: plainObject ) {
+fn.extend = function ( plugins: Record<string, any> ) {
 
   return cash.extend ( fn, plugins );
 
diff --git a/src/core/get_compare_function.ts b/src/core/get_compare_function.ts
@@ -2,16 +2,16 @@
 // @require ./matches.ts
 // @require ./type_checking.ts
 
-function getCompareFunction ( comparator?: Comparator ): (( i: number, ele: Ele ) => boolean) {
+function getCompareFunction ( comparator?: Comparator ): (( i: number, ele: EleLoose ) => boolean) {
 
   return isString ( comparator )
-           ? ( i: number, ele: Ele ) => matches ( ele, comparator )
+           ? ( i: number, ele: EleLoose ) => matches ( ele, comparator )
            : isFunction ( comparator )
              ? comparator
              : isCash ( comparator )
-               ? ( i: number, ele: Ele ) => comparator.is ( ele )
+               ? ( i: number, ele: EleLoose ) => comparator.is ( ele )
                : !comparator
                  ? () => false
-                 : ( i: number, ele: Ele ) => ele === comparator;
+                 : ( i: number, ele: EleLoose ) => ele === comparator;
 
 }
diff --git a/src/core/parse_html.ts b/src/core/parse_html.ts
@@ -6,7 +6,7 @@
 // @require manipulation/detach.ts
 
 interface CashStatic {
-  parseHTML ( html: string ): Ele[];
+  parseHTML ( html: string ): EleLoose[];
 }
 
 const fragmentRe = /^\s*<(\w+)[^>]*>/,
@@ -22,7 +22,7 @@ const containers = {
   tfoot: table
 };
 
-function parseHTML ( html: string ): Ele[] {
+function parseHTML ( html: string ): EleLoose[] {
 
   if ( !isString ( html ) ) return [];
 
diff --git a/src/core/pluck.ts b/src/core/pluck.ts
@@ -2,13 +2,13 @@
 // @require ./type_checking.ts
 // @require ./variables.ts
 
-type PluckCallback<T> = ( ele: T ) => ArrayLike<T>;
+type PluckCallback<T> = ( ele: T ) => ArrayLike<Ele>;
 
-function pluck<T> ( arr: ArrayLike<T>, prop: PluckCallback<T> ): Array<T>;
-function pluck<T> ( arr: ArrayLike<T>, prop: string, deep?: boolean ): Array<T>;
-function pluck<T> ( arr: ArrayLike<T>, prop: string | PluckCallback<T>, deep?: boolean ): Array<T> {
+function pluck<T, U extends ArrayLike<T> = ArrayLike<T>> ( arr: U, prop: PluckCallback<U[0]> ): Array<Ele>;
+function pluck<T, U extends ArrayLike<T> = ArrayLike<T>> ( arr: U, prop: string, deep?: boolean ): Array<Ele>;
+function pluck<T, U extends ArrayLike<T> = ArrayLike<T>> ( arr: U, prop: string | PluckCallback<U[0]>, deep?: boolean ): Array<Ele> {
 
-  const plucked: Array<T> = [],
+  const plucked: Array<Ele> = [],
         isCallback = isFunction ( prop );
 
   for ( let i = 0, l = arr.length; i < l; i++ ) {
diff --git a/src/core/types.ts b/src/core/types.ts
@@ -1,4 +1,10 @@
 
+interface Event {
+  namespace: string,
+  data: any,
+  ___cd?: boolean // Delegate
+}
+
 interface Cash {
   [index: number]: EleLoose | undefined,
   length: number,
@@ -10,15 +16,14 @@ interface CashStatic {
   fn: Cash
 }
 
-type plainObject = { [index: string]: any };
 type falsy = undefined | null | false | 0 | '';
 
 type EleHTML = HTMLElement | HTMLAnchorElement | HTMLAppletElement | HTMLAreaElement | HTMLAudioElement | HTMLBRElement | HTMLBaseElement | HTMLBaseFontElement | HTMLBodyElement | HTMLButtonElement | HTMLCanvasElement | HTMLDListElement | HTMLDataElement | HTMLDataListElement | HTMLDetailsElement | HTMLDialogElement | HTMLDirectoryElement | HTMLDivElement | HTMLEmbedElement | HTMLFieldSetElement | HTMLFontElement | HTMLFormElement | HTMLFrameElement | HTMLFrameSetElement | HTMLHRElement | HTMLHeadElement | HTMLHeadingElement | HTMLHtmlElement | HTMLIFrameElement | HTMLImageElement | HTMLInputElement | HTMLLIElement | HTMLLabelElement | HTMLLegendElement | HTMLLinkElement | HTMLMapElement | HTMLMarqueeElement | HTMLMediaElement | HTMLMenuElement | HTMLMetaElement | HTMLMeterElement | HTMLModElement | HTMLOListElement | HTMLObjectElement | HTMLOptGroupElement | HTMLOptionElement | HTMLOrSVGElement | HTMLOutputElement | HTMLParagraphElement | HTMLParamElement | HTMLPictureElement | HTMLPreElement | HTMLProgressElement | HTMLQuoteElement | HTMLScriptElement | HTMLSelectElement | HTMLSlotElement | HTMLSourceElement | HTMLSpanElement | HTMLStyleElement | HTMLTableCaptionElement | HTMLTableCellElement | HTMLTableColElement | HTMLTableDataCellElement | HTMLTableElement | HTMLTableHeaderCellElement | HTMLTableRowElement | HTMLTableSectionElement | HTMLTemplateElement | HTMLTextAreaElement | HTMLTimeElement | HTMLTitleElement | HTMLTrackElement | HTMLUListElement | HTMLUnknownElement | HTMLVideoElement;
 type EleHTMLLoose = HTMLElement & HTMLAnchorElement & HTMLAppletElement & HTMLAreaElement & HTMLAudioElement & HTMLBRElement & HTMLBaseElement & HTMLBaseFontElement & HTMLBodyElement & HTMLButtonElement & HTMLCanvasElement & HTMLDListElement & HTMLDataElement & HTMLDataListElement & HTMLDetailsElement & HTMLDialogElement & HTMLDirectoryElement & HTMLDivElement & HTMLEmbedElement & HTMLFieldSetElement & HTMLFontElement & HTMLFormElement & HTMLFrameElement & HTMLFrameSetElement & HTMLHRElement & HTMLHeadElement & HTMLHeadingElement & HTMLHtmlElement & HTMLIFrameElement & HTMLImageElement & HTMLInputElement & HTMLLIElement & HTMLLabelElement & HTMLLegendElement & HTMLLinkElement & HTMLMapElement & HTMLMarqueeElement & HTMLMediaElement & HTMLMenuElement & HTMLMetaElement & HTMLMeterElement & HTMLModElement & HTMLOListElement & HTMLObjectElement & HTMLOptGroupElement & HTMLOptionElement & HTMLOrSVGElement & HTMLOutputElement & HTMLParagraphElement & HTMLParamElement & HTMLPictureElement & HTMLPreElement & HTMLProgressElement & HTMLQuoteElement & HTMLScriptElement & HTMLSelectElement & HTMLSlotElement & HTMLSourceElement & HTMLSpanElement & HTMLStyleElement & HTMLTableCaptionElement & HTMLTableCellElement & HTMLTableColElement & HTMLTableDataCellElement & HTMLTableElement & HTMLTableHeaderCellElement & HTMLTableRowElement & HTMLTableSectionElement & HTMLTemplateElement & HTMLTextAreaElement & HTMLTimeElement & HTMLTitleElement & HTMLTrackElement & HTMLUListElement & HTMLUnknownElement & HTMLVideoElement;
 type Ele = Window | Document | EleHTML | Element | Node;
 type EleLoose = Window & Document & EleHTMLLoose & Element & Node; //UGLY: Trick to remove some kind-of useless type errors //URL: https://github.com/kenwheeler/cash/issues/278
 type Selector = falsy | string | Function | HTMLCollection | NodeList | Ele | Ele[] | ArrayLike<Ele> | Cash;
-type Comparator = string | Ele | Cash | (( this: Ele, index: number, ele: Ele ) => boolean);
+type Comparator = string | Ele | Cash | (( this: EleLoose, index: number, ele: EleLoose ) => boolean);
 type Context = Document | EleHTML | Element;
 
 type EventCallback = {
diff --git a/src/css/css.ts b/src/css/css.ts
@@ -9,14 +9,14 @@
 
 interface Cash {
   css ( prop: string ): string | undefined;
-  css ( prop: string, value: string ): this;
-  css ( props: plainObject ): this;
+  css ( prop: string, value: number | string ): this;
+  css ( props: Record<string, number | string> ): this;
 }
 
 function css ( this: Cash, prop: string ): string | undefined;
-function css ( this: Cash, prop: string, value: string ): Cash;
-function css ( this: Cash, prop: plainObject ): Cash;
-function css ( this: Cash, prop: string | plainObject, value?: string ) {
+function css ( this: Cash, prop: string, value: number | string ): Cash;
+function css ( this: Cash, prop: Record<string, number | string> ): Cash;
+function css ( this: Cash, prop: string | Record<string, number | string>, value?: number | string ) {
 
   if ( isString ( prop ) ) {
 
@@ -36,11 +36,11 @@ function css ( this: Cash, prop: string | plainObject, value?: string ) {
 
       if ( isVariable ) {
 
-        ele.style.setProperty ( prop as string, value ); //TSC
+        ele.style.setProperty ( prop, value );
 
       } else {
 
-        ele.style[prop as string] = value; //TSC
+        ele.style[prop] = value;
 
       }
 
diff --git a/src/css/helpers/compute_style.ts b/src/css/helpers/compute_style.ts
@@ -2,7 +2,7 @@
 // @require core/type_checking.ts
 // @require core/variables.ts
 
-function computeStyle ( ele: Ele, prop: string, isVariable?: boolean ): string | undefined {
+function computeStyle ( ele: EleLoose, prop: string, isVariable?: boolean ): string | undefined {
 
   if ( !isElement ( ele ) || !prop ) return;
 
diff --git a/src/css/helpers/compute_style_int.ts b/src/css/helpers/compute_style_int.ts
@@ -1,7 +1,7 @@
 
 // @require ./compute_style.ts
 
-function computeStyleInt ( ele: Ele, prop: string ): number {
+function computeStyleInt ( ele: EleLoose, prop: string ): number {
 
   return parseInt ( computeStyle ( ele, prop ), 10 ) || 0;
 
diff --git a/src/css/helpers/get_suffixed_value.ts b/src/css/helpers/get_suffixed_value.ts
@@ -16,7 +16,7 @@ const numericProps: { [prop: string]: true | undefined } = {
   zIndex: true
 };
 
-function getSuffixedValue ( prop: string, value: string, isVariable: boolean = isCSSVariable ( prop ) ): string {
+function getSuffixedValue ( prop: string, value: number | string, isVariable: boolean = isCSSVariable ( prop ) ): string {
 
   return !isVariable && !numericProps[prop] && isNumeric ( value ) ? `${value}px` : value;
 
diff --git a/src/data/data.ts b/src/data/data.ts
@@ -6,17 +6,17 @@
 // @require ./helpers/set_data.ts
 
 interface Cash {
-  data (): plainObject | undefined;
+  data (): Record<string, any> | undefined;
   data ( name: string ): any;
   data ( name: string, value: any ): this;
-  data ( datas: plainObject ): this;
+  data ( datas: Record<string, any> ): this;
 }
 
-function data ( this: Cash ): plainObject | undefined;
+function data ( this: Cash ): Record<string, any> | undefined;
 function data ( this: Cash, name: string ): any;
 function data ( this: Cash, name: string, value: any ): Cash;
-function data ( this: Cash, name: plainObject ): Cash;
-function data ( this: Cash, name?: string | plainObject, value?: any ) {
+function data ( this: Cash, name: Record<string, any> ): Cash;
+function data ( this: Cash, name?: string | Record<string, any>, value?: any ) {
 
   if ( !name ) {
 
diff --git a/src/data/helpers/get_data.ts b/src/data/helpers/get_data.ts
@@ -1,7 +1,7 @@
 
 // @require core/camel_case.ts
 
-function getData ( ele: Ele, key: string ): any {
+function getData ( ele: EleLoose, key: string ): any {
 
   const value = ele.dataset[key] || ele.dataset[camelCase ( key )];
 
diff --git a/src/data/helpers/set_data.ts b/src/data/helpers/set_data.ts
@@ -1,7 +1,7 @@
 
 // @require core/camel_case.ts
 
-function setData ( ele: Ele, key: string, value: any ): void {
+function setData ( ele: EleLoose, key: string, value: any ): void {
 
   try {
 
diff --git a/src/dimensions/helpers/get_extra_space.ts b/src/dimensions/helpers/get_extra_space.ts
@@ -1,7 +1,7 @@
 
 // @require css/helpers/compute_style_int.ts
 
-function getExtraSpace ( ele: Element, xAxis?: boolean ): number {
+function getExtraSpace ( ele: EleLoose, xAxis?: boolean ): number {
 
   return computeStyleInt ( ele, `border${ xAxis ? 'Left' : 'Top' }Width` ) + computeStyleInt ( ele, `padding${ xAxis ? 'Left' : 'Top' }` ) + computeStyleInt ( ele, `padding${ xAxis ? 'Right' : 'Bottom' }` ) + computeStyleInt ( ele, `border${ xAxis ? 'Right' : 'Bottom' }Width` );
 
diff --git a/src/dimensions/inner_outer.ts b/src/dimensions/inner_outer.ts
@@ -15,7 +15,7 @@ each ( [true, false], ( i, outer?: boolean ) => {
 
   each ( ['Width', 'Height'], ( i, prop: 'Width' | 'Height' ) => {
 
-    const name = `${outer ? 'outer' : 'inner'}${prop}`;
+    const name: 'outerWidth' | 'innerHeight' = `${outer ? 'outer' : 'inner'}${prop}`;
 
     fn[name] = function ( this: Cash, includeMargins?: boolean ) {
 
diff --git a/src/dimensions/normal.ts b/src/dimensions/normal.ts
@@ -29,7 +29,7 @@ each ( ['width', 'height'], ( index: number, prop: 'width' | 'height' ) => {
 
     }
 
-    const valueNumber = parseInt ( value as string, 10 ); //TSC
+    const valueNumber = parseInt ( value, 10 );
 
     return this.each ( ( i, ele ) => {
 
diff --git a/src/effects/helpers/is_hidden.ts b/src/effects/helpers/is_hidden.ts
@@ -1,7 +1,7 @@
 
 // @require css/helpers/compute_style.ts
 
-function isHidden ( ele: Element ): boolean {
+function isHidden ( ele: EleLoose ): boolean {
 
   return computeStyle ( ele, 'display' ) === 'none';
 
diff --git a/src/events/helpers/add_event.ts b/src/events/helpers/add_event.ts
@@ -2,7 +2,7 @@
 // @require core/guid.ts
 // @require events/helpers/get_events_cache.ts
 
-function addEvent ( ele: Ele, name: string, namespaces: string[], selector: string, callback: EventCallback ): void {
+function addEvent ( ele: EleLoose, name: string, namespaces: string[], selector: string, callback: EventCallback ): void {
 
   callback.guid = callback.guid || cash.guid++;
 
diff --git a/src/events/helpers/get_events_cache.ts b/src/events/helpers/get_events_cache.ts
@@ -1,7 +1,7 @@
 
 // @require ./variables.ts
 
-function getEventsCache ( ele: Ele ): { [event: string]: [string[], string, EventCallback][] } {
+function getEventsCache ( ele: EleLoose ): { [event: string]: [string[], string, EventCallback][] } {
 
   return ele[eventsNamespace] = ( ele[eventsNamespace] || {} );
 
diff --git a/src/events/helpers/remove_event.ts b/src/events/helpers/remove_event.ts
@@ -3,7 +3,7 @@
 // @require ./has_namespaces.ts
 // @require ./parse_event_name.ts
 
-function removeEvent ( ele: Ele, name?: string, namespaces?: string[], selector?: string, callback?: EventCallback ): void {
+function removeEvent ( ele: EleLoose, name?: string, namespaces?: string[], selector?: string, callback?: EventCallback ): void {
 
   const cache = getEventsCache ( ele );
 
diff --git a/src/events/off.ts b/src/events/off.ts
@@ -10,12 +10,12 @@
 interface Cash {
   off (): this;
   off ( events: string ): this;
-  off ( events: plainObject ): this;
+  off ( events: Record<string, EventCallback> ): this;
   off ( events: string, callback: EventCallback ): this;
   off ( events: string, selector: string, callback: EventCallback ): this;
 }
 
-fn.off = function ( this: Cash, eventFullName?: string | plainObject, selector?: string | EventCallback, callback?: EventCallback ) {
+fn.off = function ( this: Cash, eventFullName?: string | Record<string, EventCallback>, selector?: string | EventCallback, callback?: EventCallback ) {
 
   if ( isUndefined ( eventFullName ) ) {
 
@@ -42,7 +42,7 @@ fn.off = function ( this: Cash, eventFullName?: string | plainObject, selector?:
 
       const [name, namespaces] = parseEventName ( getEventNameBubbling ( eventFullName ) );
 
-      this.each ( ( i, ele ) => { removeEvent ( ele, name, namespaces, selector as string, callback ) } ); //TSC
+      this.each ( ( i, ele ) => { removeEvent ( ele, name, namespaces, selector, callback ) } );
 
     });
 
diff --git a/src/events/on.ts b/src/events/on.ts
diff --git a/src/events/one.ts b/src/events/one.ts
diff --git a/src/extra/shorthands.ts b/src/extra/shorthands.ts
diff --git a/src/forms/helpers/get_value.ts b/src/forms/helpers/get_value.ts
diff --git a/src/forms/serialize.ts b/src/forms/serialize.ts
diff --git a/src/manipulation/helpers/eval_scripts.ts b/src/manipulation/helpers/eval_scripts.ts
diff --git a/src/manipulation/helpers/insert_element.ts b/src/manipulation/helpers/insert_element.ts
diff --git a/src/manipulation/helpers/insert_selectors.ts b/src/manipulation/helpers/insert_selectors.ts
diff --git a/src/manipulation/wrap_all.ts b/src/manipulation/wrap_all.ts
diff --git a/src/traversal/has.ts b/src/traversal/has.ts
diff --git a/src/traversal/is.ts b/src/traversal/is.ts
diff --git a/src/traversal/not.ts b/src/traversal/not.ts

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ interface CashStatic {`
`7`	`7`	`each<T> ( arr: ArrayLike<T>, callback: EachCallback<T> ): void;`
`8`	`8`	`}`
`9`	`9`
`10`		`-function each<T> ( arr: ArrayLike<T>, callback: EachCallback<T>, reverse?: boolean ): ArrayLike<T> { //TODO: Maybe add a flag for looping in reverse`
	`10`	`+function each<T, U extends ArrayLike<T> = ArrayLike<T>> ( arr: U, callback: EachCallback<U[0]>, reverse?: boolean ): U {`
`11`	`11`
`12`	`12`	`if ( reverse ) {`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ interface CashStatic {`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`interface Cash {`
`9`		`- extend ( plugins: plainObject ): this;`
	`9`	`+ extend ( plugins: Record<any, any> ): this;`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`cash.extend = function ( target: any, ...objs: any[] ) {`
`@@ -27,7 +27,7 @@ cash.extend = function ( target: any, ...objs: any[] ) {`
`27`	`27`
`28`	`28`	`};`
`29`	`29`
`30`		`-fn.extend = function ( plugins: plainObject ) {`
	`30`	`+fn.extend = function ( plugins: Record<string, any> ) {`
`31`	`31`
`32`	`32`	`return cash.extend ( fn, plugins );`
`33`	`33`