Improve TypeScript declarations

kgryte · kgryte · commit a61a18cfdab2 · 2022-01-25T23:05:27.000-08:00
diff --git a/lib/node_modules/@stdlib/ndarray/array/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/array/docs/types/index.d.ts
@@ -37,11 +37,6 @@ interface Options {
 	*/
 	order?: Order;
 
-	/**
-	* Array shape.
-	*/
-	shape?: Shape;
-
 	/**
 	* Specifies how to handle indices which exceed array dimensions (default: 'throw').
 	*/
@@ -78,6 +73,63 @@ interface Options {
 	readonly?: boolean;
 }
 
+/**
+* Interface describing function options.
+*/
+interface OptionsWithShape extends Options {
+	/**
+	* Array shape.
+	*/
+	shape: Shape;
+
+	/**
+	* Data source.
+	*
+	* ## Notes
+	*
+	* -    If provided along with a `buffer` argument, the argument takes precedence.
+	*/
+	buffer?: ArrayLike<any>;
+}
+
+/**
+* Interface describing function options.
+*/
+interface OptionsWithBuffer extends Options {
+	/**
+	* Array shape.
+	*/
+	shape?: Shape;
+
+	/**
+	* Data source.
+	*
+	* ## Notes
+	*
+	* -    If provided along with a `buffer` argument, the argument takes precedence.
+	*/
+	buffer: ArrayLike<any>;
+}
+
+/**
+* Interface describing function options.
+*/
+interface ExtendedOptions extends Options {
+	/**
+	* Array shape.
+	*/
+	shape?: Shape;
+
+	/**
+	* Data source.
+	*
+	* ## Notes
+	*
+	* -    If provided along with a `buffer` argument, the argument takes precedence.
+	*/
+	buffer?: ArrayLike<any>;
+}
+
 /**
 * Returns a multidimensional array.
 *
@@ -112,7 +164,7 @@ interface Options {
 * var v = arr.get( 0 );
 * // returns [ 1, 2 ]
 */
-declare function array( options: Options ): ndarray;
+declare function array( options: OptionsWithShape | OptionsWithBuffer ): ndarray; // tslint:disable-line:max-line-length
 
 /**
 * Returns a multidimensional array.
@@ -168,7 +220,7 @@ declare function array( options: Options ): ndarray;
 * var v = arr.get( 0, 0 );
 * // returns 1.0
 */
-declare function array( buffer: ArrayLike<any>, options?: Options ): ndarray;
+declare function array( buffer: ArrayLike<any>, options?: ExtendedOptions ): ndarray; // tslint:disable-line:max-line-length
 
 
 // EXPORTS //
