feat!: move Collection type defn to array type module

kgryte · kgryte · commit bde4671201df · 2023-08-16T17:13:44.000-07:00
This commit addresses an awkward inconsistency in which a `Collection`
was included in the `object` type module, despite being defined as
a union of `array` type definitions. By moving `Collection` into
`array` we make the import of `Collection` more intuitive given its
semantic relationship to array-like objects.

BREAKING CHANGE: move `Collection` type defn to array type module

To migrate, users should import `@stdlib/types/array` instead of
`@stdlib/types/object` when using the `Collection` type definition.
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -150,7 +150,7 @@ declare module '@stdlib/types/array' {
 	* @example
 	* const x: Array1D<number> = [ 1, 2, 3, 4 ];
 	*/
-	type Array1D<T> = Array<T>; // FIXME: this should be a collection and should be updated once `Collection` is moved to the array namespace
+	type Array1D<T> = Collection<T>;
 
 	/**
 	* A two-dimensional nested array.
@@ -525,6 +525,14 @@ declare module '@stdlib/types/array' {
 		*/
 		set( value: ArrayLike<number | ComplexLike> | Complex128Array | ComplexLike, i?: number ): void;
 	}
+
+	/**
+	* A collection, which is defined as either an array, typed array, or an array-like object (excluding strings and functions).
+	*
+	* @example
+	* const x: Collection<number> = [ 1, 2, 3 ];
+	*/
+	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>;
 }
 
 /**
@@ -732,9 +740,8 @@ declare module '@stdlib/types/iter' {
 * };
 */
 declare module '@stdlib/types/ndarray' {
-	import { ArrayLike, AccessorArrayLike, Complex128Array, Complex64Array, RealOrComplexTypedArray, FloatOrComplexTypedArray, RealTypedArray, ComplexTypedArray, IntegerTypedArray, FloatTypedArray, SignedIntegerTypedArray, UnsignedIntegerTypedArray } from '@stdlib/types/array';
+	import { ArrayLike, AccessorArrayLike, Collection, Complex128Array, Complex64Array, RealOrComplexTypedArray, FloatOrComplexTypedArray, RealTypedArray, ComplexTypedArray, IntegerTypedArray, FloatTypedArray, SignedIntegerTypedArray, UnsignedIntegerTypedArray } from '@stdlib/types/array';
 	import { ComplexLike, Complex128, Complex64 } from '@stdlib/types/complex';
-	import { Collection } from '@stdlib/types/object';
 
 	/**
 	* Data type.
@@ -2511,14 +2518,6 @@ declare module '@stdlib/types/object' {
 	* const prop: PropertyName = 'foo';
 	*/
 	type PropertyName = string | symbol;
-
-	/**
-	* A collection, which is defined as either an array, typed array, or an array-like object (excluding strings and functions).
-	*
-	* @example
-	* const x: Collection<number> = [ 1, 2, 3 ];
-	*/
-	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>;
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/types/test.ts b/lib/node_modules/@stdlib/types/test.ts
@@ -355,6 +355,11 @@ function cmplx128Array(): array.Complex128Array {
 	if ( v31.length === 0 ) {
 		throw new Error( 'something went wrong' );
 	}
+
+	const v32: array.Collection<number> = [ 1, 2, 3 ];
+	if ( v32.length !== 3 ) {
+		throw new Error( 'something went wrong' );
+	}
 }
 
 // The compiler should not throw an error when using iterator or iterable types...
@@ -534,11 +539,6 @@ function cmplx128Array(): array.Complex128Array {
 	if ( prop !== 'foo' ) {
 		throw new Error( 'something went wrong' );
 	}
-
-	const arr: obj.Collection<number> = [ 1, 2, 3 ];
-	if ( arr.length !== 3 ) {
-		throw new Error( 'something went wrong' );
-	}
 }
 
 // The compiler should not throw an error when using complex number types...

Original file line number	Diff line number	Diff line change
`@@ -355,6 +355,11 @@ function cmplx128Array(): array.Complex128Array {`
`355`	`355`	`if ( v31.length === 0 ) {`
`356`	`356`	`throw new Error( 'something went wrong' );`
`357`	`357`	`}`
	`358`	`+`
	`359`	`+ const v32: array.Collection<number> = [ 1, 2, 3 ];`
	`360`	`+ if ( v32.length !== 3 ) {`
	`361`	`+ throw new Error( 'something went wrong' );`
	`362`	`+ }`
`358`	`363`	`}`
`359`	`364`
`360`	`365`	`// The compiler should not throw an error when using iterator or iterable types...`
`@@ -534,11 +539,6 @@ function cmplx128Array(): array.Complex128Array {`
`534`	`539`	`if ( prop !== 'foo' ) {`
`535`	`540`	`throw new Error( 'something went wrong' );`
`536`	`541`	`}`
`537`		`-`
`538`		`- const arr: obj.Collection<number> = [ 1, 2, 3 ];`
`539`		`- if ( arr.length !== 3 ) {`
`540`		`- throw new Error( 'something went wrong' );`
`541`		`- }`
`542`	`542`	`}`
`543`	`543`
`544`	`544`	`// The compiler should not throw an error when using complex number types...`