feat!: convert Collection to generic

kgryte · kgryte · commit edcd74294f95 · 2023-06-26T16:53:54.000-07:00
This commit converts `Collection` to a generic in order to better
preserve type information. One example is when returning an element
from a collection and wanting to preserve the returned element's
type information. This change depends on default types, support
for which was added in TypeScript version 2.3, which is beyond the
current project support version of 2.0. Accordingly, this commit
increases the minimum TypeScript version and sets that version to
4.1, which should include most new TypeScript features that we
want to use in TypeScript declarations moving forward.

BREAKING CHANGE: `Collection` is now a generic

To migrate, users should upgrade their TypeScript version and
provide element type information when using the `Collection` type
(e.g., `Collection&lt;number&gt;`). By default, the element type is `any`
which is equivalent to previous behavior.
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -18,7 +18,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Module containing array definitions.
@@ -2399,9 +2399,9 @@ declare module '@stdlib/types/object' {
 	* A collection, which is defined as either an array, typed array, or an array-like object (excluding strings and functions).
 	*
 	* @example
-	* const arr: Collection = [ 1, 2, 3 ];
+	* const arr: Collection<number> = [ 1, 2, 3 ];
 	*/
-	type Collection = Array<any> | TypedArray | ArrayLike<any>;
+	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>;
 
 	/**
 	* Complex number data type.
diff --git a/lib/node_modules/@stdlib/types/test.ts b/lib/node_modules/@stdlib/types/test.ts
@@ -484,7 +484,7 @@ function cmplx128Array(): array.Complex128Array {
 		throw new Error( 'something went wrong' );
 	}
 
-	const arr: obj.Collection = [ 1, 2, 3 ];
+	const arr: obj.Collection<number> = [ 1, 2, 3 ];
 	if ( arr.length !== 3 ) {
 		throw new Error( 'something went wrong' );
 	}

Original file line number	Diff line number	Diff line change
`@@ -484,7 +484,7 @@ function cmplx128Array(): array.Complex128Array {`
`484`	`484`	`throw new Error( 'something went wrong' );`
`485`	`485`	`}`
`486`	`486`
`487`		`- const arr: obj.Collection = [ 1, 2, 3 ];`
	`487`	`+ const arr: obj.Collection<number> = [ 1, 2, 3 ];`
`488`	`488`	`if ( arr.length !== 3 ) {`
`489`	`489`	`throw new Error( 'something went wrong' );`
`490`	`490`	`}`