Add overloads

kgryte · kgryte · commit 4d8fae27c0b2 · 2022-01-14T17:01:59.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
@@ -20,7 +20,8 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { DataType } from '@stdlib/types/array';
+import { RealDataType, ComplexDataType, DataType } from '@stdlib/types/array';
+import { ComplexLike } from '@stdlib/types/object';
 
 /**
 * Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
@@ -40,7 +41,43 @@ import { DataType } from '@stdlib/types/array';
 * var dt = minDataType( 3 );
 * // returns 'uint8'
 */
-declare function minDataType( value: any ): DataType;
+declare function minDataType( value: number ): RealDataType;
+
+/**
+* Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
+*
+* ## Notes
+*
+* -   The function does *not* provide precision guarantees for non-integer-valued real numbers. In other words, the function returns the smallest possible floating-point (i.e., inexact) data type for storing numbers having decimals.
+*
+* @param value - scalar value
+* @returns array data type
+*
+* @example
+* var z = {
+*     're': 3.141592653589793,
+*     'im': 1.0
+* };
+* var dt = minDataType( z );
+* // returns 'complex64'
+*/
+declare function minDataType( value: ComplexLike ): ComplexDataType;
+
+/**
+* Returns the minimum array data type of the closest "kind" necessary for storing a provided scalar value.
+*
+* ## Notes
+*
+* -   The function does *not* provide precision guarantees for non-integer-valued real numbers. In other words, the function returns the smallest possible floating-point (i.e., inexact) data type for storing numbers having decimals.
+*
+* @param value - scalar value
+* @returns array data type
+*
+* @example
+* var dt = minDataType( 'beep' );
+* // returns 'generic'
+*/
+declare function minDataType( value: any ): 'generic';
 
 
 // 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
@@ -23,7 +23,14 @@ import minDataType = require( './index' );
 
 // The function returns a data type..
 {
-	minDataType( 2.13 ); // $ExpectType DataType
+	const z = {
+		're': 1.0,
+		'im': 2.0
+	};
+
+	minDataType( 2.13 ); // $ExpectType RealDataType
+	minDataType( z ); // $ExpectType ComplexDataType
+	minDataType( 'beep' ); // $ExpectType "generic"
 }
 
 // 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
`@@ -23,7 +23,14 @@ import minDataType = require( './index' );`
`23`	`23`
`24`	`24`	`// The function returns a data type..`
`25`	`25`	`{`
`26`		`- minDataType( 2.13 ); // $ExpectType DataType`
	`26`	`+ const z = {`
	`27`	`+ 're': 1.0,`
	`28`	`+ 'im': 2.0`
	`29`	`+ };`
	`30`	`+`
	`31`	`+ minDataType( 2.13 ); // $ExpectType RealDataType`
	`32`	`+ minDataType( z ); // $ExpectType ComplexDataType`
	`33`	`+ minDataType( 'beep' ); // $ExpectType "generic"`
`27`	`34`	`}`
`28`	`35`
`29`	`36`	`// The compiler throws an error if the function is provided an unsupported number of arguments...`