Auto-generated commit

stdlib-bot · stdlib-bot · commit ab6a0dbc2092 · 2023-08-24T21:42:01.000Z
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
+import { Collection, Array3D } from '@stdlib/types/array';
 
 /**
 * Returns a three-dimensional nested array filled with ones.
@@ -32,7 +32,7 @@ import { Collection } from '@stdlib/types/array';
 * var out = ones3d( [ 1, 1, 3 ] );
 * // returns [ [ [ 1.0, 1.0, 1.0 ] ] ]
 */
-declare function ones3d( shape: Collection<number> ): Array<Array<Array<number>>>;
+declare function ones3d( shape: Collection<number> ): Array3D<number>;
 
 
 // EXPORTS //
diff --git a/docs/types/test.ts b/docs/types/test.ts
@@ -23,7 +23,7 @@ import ones3d = require( './index' );
 
 // The function returns a nested array...
 {
-	ones3d( [ 1, 1, 3 ] ); // $ExpectType number[][][]
+	ones3d( [ 1, 1, 3 ] ); // $ExpectType Array3D<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an array of numbers...

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ import ones3d = require( './index' );`
`23`	`23`
`24`	`24`	`// The function returns a nested array...`
`25`	`25`	`{`
`26`		`- ones3d( [ 1, 1, 3 ] ); // $ExpectType number[][][]`
	`26`	`+ ones3d( [ 1, 1, 3 ] ); // $ExpectType Array3D<number>`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`// The compiler throws an error if the function is provided a first argument which is not an array of numbers...`