feat!: refactor declarations to use generics

Author: kgryte

lib/node_modules/@stdlib/iter/to-array-view/docs/types/index.d.ts

@@ -16,31 +16,30 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
-import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
-import { ArrayLike } from '@stdlib/types/array';
+import { TypedIterator, TypedIterableIterator } from '@stdlib/types/iter';
 import { Collection } from '@stdlib/types/object';
 
 // Define a union type representing both iterable and non-iterable iterators:
-type Iterator = Iter | IterableIterator;
+type Iterator<T> = TypedIterator<T> | TypedIterableIterator<T>;
 
 /**
 * Map function invoked for each iterated value.
 *
 * @returns iterator value
 */
-type Nullary = () => any;
+type Nullary<U> = () => U;
 
 /**
 * Map function invoked for each iterated value.
 *
 * @param value - iterated value
 * @returns iterator value
 */
-type Unary = ( value: any ) => any;
+type Unary<T, U> = ( value: T ) => U;
 
 /**
 * Map function invoked for each iterated value.
@@ -49,7 +48,7 @@ type Unary = ( value: any ) => any;
 * @param index - iterated value index
 * @returns iterator value
 */
-type Binary = ( value: any, index: number ) => any;
+type Binary<T, U> = ( value: T, index: number ) => U;
 
 /**
 * Map function invoked for each iterated value.
@@ -59,7 +58,7 @@ type Binary = ( value: any, index: number ) => any;
 * @param src - source array-like object
 * @returns iterator value
 */
-type Ternary = ( value: any, index: number, src: ArrayLike<any> ) => any;
+type Ternary<T, U> = ( value: T, index: number, src: Collection<U> ) => U;
 
 /**
 * Map function invoked for each iterated value.
@@ -69,7 +68,7 @@ type Ternary = ( value: any, index: number, src: ArrayLike<any> ) => any;
 * @param src - source array-like object
 * @returns iterator value
 */
-type MapFunction = Nullary | Unary | Binary | Ternary;
+type MapFunction<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 
 /**
 * Fills an array-like object view with values returned from an iterator.
@@ -91,7 +90,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary;
 * var arr = iterator2arrayview( iter, new Float64Array( 20 ) );
 * // returns <Float64Array>
 */
-declare function iterator2arrayview( iterator: Iterator, out: Collection, mapFcn?: MapFunction, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+declare function iterator2arrayview<T = any, U = T>( iterator: Iterator<T>, out: Collection<U>, mapFcn?: MapFunction<T, U>, thisArg?: any ): Collection<U>; // tslint:disable-line:max-line-length
 
 /**
 * Fills an array-like object view with values returned from an iterator.
@@ -114,7 +113,7 @@ declare function iterator2arrayview( iterator: Iterator, out: Collection, mapFcn
 * var arr = iterator2arrayview( iter, new Float64Array( 20 ), 5 );
 * // returns <Float64Array>
 */
-declare function iterator2arrayview( iterator: Iterator, out: Collection, begin: number, mapFcn?: MapFunction, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+declare function iterator2arrayview<T = any, U = T>( iterator: Iterator<T>, out: Collection<U>, begin: number, mapFcn?: MapFunction<T, U>, thisArg?: any ): Collection<U>; // tslint:disable-line:max-line-length
 
 /**
 * Fills an array-like object view with values returned from an iterator.
@@ -138,7 +137,7 @@ declare function iterator2arrayview( iterator: Iterator, out: Collection, begin:
 * var arr = iterator2arrayview( iter, new Float64Array( 20 ), 5, 8 );
 * // returns <Float64Array>
 */
-declare function iterator2arrayview( iterator: Iterator, out: Collection, begin: number, end: number, mapFcn?: MapFunction, thisArg?: any ): Collection; // tslint:disable-line:max-line-length
+declare function iterator2arrayview<T = any, U = T>( iterator: Iterator<T>, out: Collection<U>, begin: number, end: number, mapFcn?: MapFunction<T, U>, thisArg?: any ): Collection<U>; // tslint:disable-line:max-line-length
 
 
 // EXPORTS //

lib/node_modules/@stdlib/iter/to-array-view/docs/types/test.ts

@@ -36,11 +36,11 @@ function times10( v: number ): number {
 {
 	const iter = randu( { 'iter': 10 } );
 	const out = new Float64Array( 10 );
-	iterator2arrayview( iter, out ); // $ExpectType Collection
-	iterator2arrayview( iter, out, times10 ); // $ExpectType Collection
-	iterator2arrayview( iter, out, times10, {} ); // $ExpectType Collection
-	iterator2arrayview( iter, out, 0, 10, times10 ); // $ExpectType Collection
-	iterator2arrayview( iter, out, 0, 10, times10, {} ); // $ExpectType Collection
+	iterator2arrayview( iter, out ); // $ExpectType Collection<number>
+	iterator2arrayview( iter, out, times10 ); // $ExpectType Collection<number>
+	iterator2arrayview( iter, out, times10, {} ); // $ExpectType Collection<number>
+	iterator2arrayview( iter, out, 0, 10, times10 ); // $ExpectType Collection<number>
+	iterator2arrayview( iter, out, 0, 10, times10, {} ); // $ExpectType Collection<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an iterator...