Update return type

kgryte · kgryte · commit b93ff4b9e313 · 2022-01-14T16:30:52.000-08:00
diff --git a/lib/node_modules/@stdlib/array/min-dtype/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/min-dtype/docs/types/index.d.ts
@@ -18,6 +18,10 @@
 
 // TypeScript Version: 2.0
 
+/// <reference types="@stdlib/types"/>
+
+import { DataType } from '@stdlib/types/array';
+
 /**
 * Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
 *
@@ -36,7 +40,7 @@
 * var dt = minDataType( 3 );
 * // returns 'uint8'
 */
-declare function minDataType( value: any ): string;
+declare function minDataType( value: any ): DataType;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/array/min-dtype/docs/types/test.ts b/lib/node_modules/@stdlib/array/min-dtype/docs/types/test.ts
@@ -18,11 +18,12 @@
 
 import minDataType = require( './index' );
 
+
 // TESTS //
 
-// The function returns a string..
+// The function returns a data type..
 {
-	minDataType( 2.13 ); // $ExpectType string
+	minDataType( 2.13 ); // $ExpectType DataType
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...

Original file line number	Diff line number	Diff line change
`@@ -18,11 +18,12 @@`
`18`	`18`
`19`	`19`	`import minDataType = require( './index' );`
`20`	`20`
	`21`	`+`
`21`	`22`	`// TESTS //`
`22`	`23`
`23`		`-// The function returns a string..`
	`24`	`+// The function returns a data type..`
`24`	`25`	`{`
`25`		`- minDataType( 2.13 ); // $ExpectType string`
	`26`	`+ minDataType( 2.13 ); // $ExpectType DataType`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`// The compiler throws an error if the function is provided an unsupported number of arguments...`