Use data type map instead of overloads

lib/node_modules/@stdlib/array/empty/docs/types/index.d.ts

@@ -20,228 +20,11 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Complex128Array, Complex64Array, DataType } from '@stdlib/types/array';
+import { ArrayDataTypeMap } from '@stdlib/types/array';
 
 /**
 * Creates an uninitialized array having a specified length.
 *
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'float64' );
-* // returns <Float64Array>
-*/
-declare function empty( length: number, dtype: 'float64' ): Float64Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'float32' );
-* // returns <Float32Array>
-*/
-declare function empty( length: number, dtype: 'float32' ): Float32Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'complex128' );
-* // returns <Complex128Array>
-*/
-declare function empty( length: number, dtype: 'complex128' ): Complex128Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'complex64' );
-* // returns <Complex64Array>
-*/
-declare function empty( length: number, dtype: 'complex64' ): Complex64Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'int32' );
-* // returns <Int32Array>
-*/
-declare function empty( length: number, dtype: 'int32' ): Int32Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'int16' );
-* // returns <Int16Array>
-*/
-declare function empty( length: number, dtype: 'int16' ): Int16Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'int8' );
-* // returns <Int8Array>
-*/
-declare function empty( length: number, dtype: 'int8' ): Int8Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'uint32' );
-* // returns <Uint32Array>
-*/
-declare function empty( length: number, dtype: 'uint32' ): Uint32Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'uint16' );
-* // returns <Uint16Array>
-*/
-declare function empty( length: number, dtype: 'uint16' ): Uint16Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'uint8' );
-* // returns <Uint8Array>
-*/
-declare function empty( length: number, dtype: 'uint8' ): Uint8Array;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns empty array
-*
-* @example
-* var arr = empty( 2, 'uint8c' );
-* // returns <Uint8ClampedArray>
-*/
-declare function empty( length: number, dtype: 'uint8c' ): Uint8ClampedArray;
-
-/**
-* Creates a zero-filled array having a specified length.
-*
-* @param length - array length
-* @param dtype - data type
-* @returns zero-filled array
-*
-* @example
-* var arr = empty( 2, 'generic' );
-* // returns
-*/
-declare function empty( length: number, dtype: 'generic' ): Array<number>;
-
-/**
-* Creates an uninitialized array having a specified length.
-*
-* ## Notes
-*
-* -   In browser environments, the function always returns zero-filled arrays.
-* -   If `dtype` is `'generic'`, the function always returns a zero-filled array.
-* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
-*
 * The function recognizes the following data types:
 *
 * -   `float64`: double-precision floating-point numbers (IEEE 754)
@@ -257,6 +40,12 @@ declare function empty( length: number, dtype: 'generic' ): Array<number>;
 * -   `uint8c`: 8-bit unsigned integers clamped to `0-255`
 * -   `generic`: generic JavaScript values
 *
+* ## Notes
+*
+* -   In browser environments, the function always returns zero-filled arrays.
+* -   If `dtype` is `'generic'`, the function always returns a zero-filled array.
+* -   In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data.
+*
 * @param length - array length
 * @param dtype - data type (default: 'float64')
 * @returns empty array
@@ -269,7 +58,7 @@ declare function empty( length: number, dtype: 'generic' ): Array<number>;
 * var arr = empty( 2, 'float32' );
 * // returns <Float32Array>
 */
-declare function empty( length: number, dtype?: DataType ): Float64Array;
+declare function empty<T extends keyof ArrayDataTypeMap<number> = 'float64'>( length: number, dtype?: T ): ArrayDataTypeMap<number>[T];
 
 
 // EXPORTS //

lib/node_modules/@stdlib/types/index.d.ts

@@ -593,6 +593,37 @@
 	* const x: Collection<number> = [ 1, 2, 3 ];
 	*/
 	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+	/**
+	* Type mapping for the following array data types:
+	*
+	* -   `float64`: double-precision floating-point numbers (IEEE 754)
+	* -   `float32`: single-precision floating-point numbers (IEEE 754)
+	* -   `complex128`: double-precision complex floating-point numbers
+	* -   `complex64`: single-precision complex floating-point numbers
+	* -   `int32`: 32-bit two's complement signed integers
+	* -   `uint32`: 32-bit unsigned integers
+	* -   `int16`: 16-bit two's complement signed integers
+	* -   `uint16`: 16-bit unsigned integers
+	* -   `int8`: 8-bit two's complement signed integers
+	* -   `uint8`: 8-bit unsigned integers
+	* -   `uint8c`: 8-bit unsigned integers clamped to `0-255`
+	* -   `generic`: generic JavaScript values
+	*/
+	type ArrayDataTypeMap<T> = { // eslint-disable-line @typescript-eslint/consistent-type-definitions
+		'float64': Float64Array;
+		'float32': Float32Array;
+		'complex128': Complex128Array;
+		'complex64': Complex64Array;
+		'int32': Int32Array;
+		'uint32': Uint32Array;
+		'int16': Int16Array;
+		'uint16': Uint16Array;
+		'int8': Int8Array;
+		'uint8': Uint8Array;
+		'uint8c': Uint8ClampedArray;
+		'generic': Array<T>;
+	};
 }
 
 /**
@@ -2728,7 +2759,7 @@
 		/**
 		* Value associated with a property (default: `undefined`).
 		*/
 		value?: any;
 	}
 
 	/**
@@ -2762,7 +2793,7 @@
 		* -   When the property is accessed, the function is called without arguments and with `this` set to the object through which the property is accessed (note: this may **not** be the object on which the property is defined due to inheritance).
 		* -   The return value will be used as the value of the property.
 		*/
 		get?(): any;
 
 		/**
 		* A function which serves as a setter for the property.
@@ -2772,7 +2803,7 @@
 		* -   If omitted from a descriptor, a property value cannot be assigned.
 		* -   When the property is assigned to, the function is called with one argument (the value being assigned to the property) and with `this` set to the object through which the property is assigned.
 		*/
 		set?( x: any ): void;
 	}
 
 	/**
@@ -2901,7 +2932,7 @@
 	* @example
 	* const rand: PRNG = () => 3.14;
 	*/
 	type PRNG = ( ...args: Array<any> ) => number;
 
 	/**
 	* A pseudorandom number generator (PRNG) seed for the 32-bit Mersenne Twister (MT19937) PRNG.