Add collection type

Planeshifter · Planeshifter · commit 3b02ff0c4f63 · 2019-05-29T12:17:05.000+02:00
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -187,6 +187,8 @@ declare module '@stdlib/types/iter' {
 * };
 */
 declare module '@stdlib/types/object' {
+	import { ArrayLike, TypedArray } from '@stdlib/types/array';
+
 	/**
 	* Interface describing a data property descriptor object.
 	*
@@ -284,6 +286,14 @@ 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 arr: Collection = [ 1, 2, 3 ];
+	*/
+	type Collection = Array<any> | TypedArray | ArrayLike<any>;
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/types/test.ts b/lib/node_modules/@stdlib/types/test.ts
@@ -282,6 +282,11 @@ function createIterableIterator(): iter.IterableIterator {
 	if ( prop !== 'foo' ) {
 		throw new Error( 'something went wrong' );
 	}
+
+	const arr: obj.Collection = [ 1, 2, 3 ];
+	if ( arr.length !== 3 ) {
+		throw new Error( 'something went wrong' );
+	}
 }
 
 // The compiler should not throw an error when using PRNG types...

Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,11 @@ function createIterableIterator(): iter.IterableIterator {`
`282`	`282`	`if ( prop !== 'foo' ) {`
`283`	`283`	`throw new Error( 'something went wrong' );`
`284`	`284`	`}`
	`285`	`+`
	`286`	`+ const arr: obj.Collection = [ 1, 2, 3 ];`
	`287`	`+ if ( arr.length !== 3 ) {`
	`288`	`+ throw new Error( 'something went wrong' );`
	`289`	`+ }`
`285`	`290`	`}`
`286`	`291`
`287`	`292`	`// The compiler should not throw an error when using PRNG types...`