feat!: refactor declarations to use generics

Author: kgryte

lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
@@ -130,7 +130,7 @@ type GetComplex64 = ( arr: Complex64Array, idx: number ) => Complex64 | void;
 * @param idx - element index
 * @returns element value
 */
-type GetGeneric = ( arr: Array<any>, idx: number ) => any;
+type GetGeneric<T> = ( arr: Array<T>, idx: number ) => T;
 
 /**
 * Returns an element from an indexed array-like object.
@@ -139,7 +139,7 @@ type GetGeneric = ( arr: Array<any>, idx: number ) => any;
 * @param idx - element index
 * @returns element value
 */
-type GetIndexedArrayLike = ( arr: Collection, idx: number ) => any;
+type GetIndexedArrayLike<T> = ( arr: Collection<T>, idx: number ) => T;
 
 /**
 * Returns an element from an array-like object supporting the get/set protocol.
@@ -148,7 +148,7 @@ type GetIndexedArrayLike = ( arr: Collection, idx: number ) => any;
 * @param idx - element index
 * @returns element value
 */
-type GetAccessorArrayLike = ( arr: AccessorArrayLike<any>, idx: number ) => any;
+type GetAccessorArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
 
 /**
 * Sets an element in a `Float64Array`.
@@ -256,7 +256,7 @@ type SetComplex64 = ( arr: Complex64Array, idx: number, value: ComplexLike ) =>
 * @param idx - element index
 * @param value - value to set
 */
-type SetGeneric = ( arr: Array<any>, idx: number, value: any ) => void;
+type SetGeneric<T> = ( arr: Array<T>, idx: number, value: T ) => void;
 
 /**
 * Sets an element in an indexed array-like object.
@@ -265,7 +265,7 @@ type SetGeneric = ( arr: Array<any>, idx: number, value: any ) => void;
 * @param idx - element index
 * @param value - value to set
 */
-type SetIndexedArrayLike = ( arr: Collection, idx: number, value: any ) => void;
+type SetIndexedArrayLike<T> = ( arr: Collection<T>, idx: number, value: T ) => void; // tslint:disable-line:max-line-length
 
 /**
 * Sets an element in an array-like object supporting the get/set protocol.
@@ -274,7 +274,7 @@ type SetIndexedArrayLike = ( arr: Collection, idx: number, value: any ) => void;
 * @param idx - element index
 * @param value - value to set
 */
-type SetAccessorArrayLike = ( arr: AccessorArrayLike<any>, idx: number, value: any ) => void; // tslint:disable-line:max-line-length
+type SetAccessorArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => void; // tslint:disable-line:max-line-length
 
 /**
 * Interface describing the output object for a `Float64Array`.
@@ -444,7 +444,7 @@ interface Complex64AccessorObject {
 /**
 * Interface describing the output object for a "generic" array not supporting the get/set protocol.
 */
-interface GenericAccessorObject {
+interface GenericAccessorObject<T> {
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -453,13 +453,13 @@ interface GenericAccessorObject {
 	/**
 	* Two-element array whose first element is an accessor for retrieving an array element and whose second element is an accessor for setting an array element.
 	*/
-	accessors: [ GetGeneric, SetGeneric ];
+	accessors: [ GetGeneric<T>, SetGeneric<T> ];
 }
 
 /**
 * Interface describing the output object for an indexed array-like object.
 */
-interface IndexedAccessorObject {
+interface IndexedAccessorObject<T> {
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -468,13 +468,13 @@ interface IndexedAccessorObject {
 	/**
 	* Two-element array whose first element is an accessor for retrieving an array element and whose second element is an accessor for setting an array element.
 	*/
-	accessors: [ GetIndexedArrayLike, SetIndexedArrayLike ];
+	accessors: [ GetIndexedArrayLike<T>, SetIndexedArrayLike<T> ];
 }
 
 /**
 * Interface describing the output object for an array-like object supporting the get/set protocol.
 */
-interface GetSetAccessorObject {
+interface GetSetAccessorObject<T> {
 	/**
 	* Boolean indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).
 	*/
@@ -483,7 +483,7 @@ interface GetSetAccessorObject {
 	/**
 	* Two-element array whose first element is an accessor for retrieving an array element and whose second element is an accessor for setting an array element.
 	*/
-	accessors: [ GetAccessorArrayLike, SetAccessorArrayLike ];
+	accessors: [ GetAccessorArrayLike<T>, SetAccessorArrayLike<T> ];
 }
 
 /**
@@ -830,7 +830,7 @@ declare function accessors( x: Complex64Array ): Complex64AccessorObject;
 * var v = fcns[ 0 ]( x, 2 );
 * // returns 3
 */
-declare function accessors( x: AccessorArrayLike<any> ): GetSetAccessorObject;
+declare function accessors<T = any>( x: AccessorArrayLike<T> ): GetSetAccessorObject<T>; // tslint:disable-line:max-line-length
 
 /**
 * Returns element accessors for a provided "generic" array.
@@ -856,7 +856,7 @@ declare function accessors( x: AccessorArrayLike<any> ): GetSetAccessorObject;
 * var v = fcns[ 0 ]( x, 2 );
 * // returns 3
 */
-declare function accessors( x: Array<any> ): GenericAccessorObject;
+declare function accessors<T = any>( x: Array<T> ): GenericAccessorObject<T>;
 
 /**
 * Returns element accessors for a provided array-like object.
@@ -888,7 +888,7 @@ declare function accessors( x: Array<any> ): GenericAccessorObject;
 * var v = fcns[ 0 ]( x, 2 );
 * // returns 3
 */
-declare function accessors( x: Collection ): IndexedAccessorObject;
+declare function accessors<T = any>( x: Collection<T> ): IndexedAccessorObject<T>; // tslint:disable-line:max-line-length
 
 
 // EXPORTS //

lib/node_modules/@stdlib/array/base/accessors/docs/types/test.ts

@@ -69,7 +69,7 @@ function arrayLike(): ArrayLike<number> {
 // The function returns an accessor object...
 {
 	const x1 = [ 1, 2, 3, 4, 5, 6 ];
-	accessors( x1 ); // $ExpectType GenericAccessorObject
+	accessors( x1 ); // $ExpectType GenericAccessorObject<number>
 
 	const x2 = new Float64Array( [ 1, 2, 3, 4, 5, 6 ] );
 	accessors( x2 ); // $ExpectType Float64AccessorObject
@@ -105,10 +105,10 @@ function arrayLike(): ArrayLike<number> {
 	accessors( x12 ); // $ExpectType Complex64AccessorObject
 
 	const x13 = accessorArray();
-	accessors( x13 ); // $ExpectType GetSetAccessorObject
+	accessors( x13 ); // $ExpectType GetSetAccessorObject<number>
 
 	const x14 = arrayLike();
-	accessors( x14 ); // $ExpectType IndexedAccessorObject
+	accessors( x14 ); // $ExpectType IndexedAccessorObject<number>
 }
 
 // The compiler throws an error if the function is not provided an array-like object...