Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -23,6 +23,7 @@
 
 ### Bug Fixes
 
+-   [`098451f`](https://github.com/stdlib-js/stdlib/commit/098451fcfd33729cc05260ae5c74113819741f80) - widen `mode` option type in `ndarray/sub2ind` to accept a single mode [(#12628)](https://github.com/stdlib-js/stdlib/pull/12628)
 -   [`b696736`](https://github.com/stdlib-js/stdlib/commit/b696736186a5c6acce24c49f6b613832941c0cf1) - bind generic type parameter to input ndarray in `ndarray/with` [(#12626)](https://github.com/stdlib-js/stdlib/pull/12626)
 -   [`a2a20a2`](https://github.com/stdlib-js/stdlib/commit/a2a20a2a6731a73a6e58cdf84d4e527ae939799e) - infer input ndarray type in `ndarray/some-by` assign overloads [(#12627)](https://github.com/stdlib-js/stdlib/pull/12627)
 -   [`07a3349`](https://github.com/stdlib-js/stdlib/commit/07a3349f6ab025490bafad9cd3b2d08df70f1fed) - use correct export names [(#12665)](https://github.com/stdlib-js/stdlib/pull/12665)
@@ -39,6 +40,7 @@
 
 <details>
 
+-   [`098451f`](https://github.com/stdlib-js/stdlib/commit/098451fcfd33729cc05260ae5c74113819741f80) - **fix:** widen `mode` option type in `ndarray/sub2ind` to accept a single mode [(#12628)](https://github.com/stdlib-js/stdlib/pull/12628) _(by Philipp Burckhardt, Athan Reines)_
 -   [`b696736`](https://github.com/stdlib-js/stdlib/commit/b696736186a5c6acce24c49f6b613832941c0cf1) - **fix:** bind generic type parameter to input ndarray in `ndarray/with` [(#12626)](https://github.com/stdlib-js/stdlib/pull/12626) _(by Philipp Burckhardt)_
 -   [`a2a20a2`](https://github.com/stdlib-js/stdlib/commit/a2a20a2a6731a73a6e58cdf84d4e527ae939799e) - **fix:** infer input ndarray type in `ndarray/some-by` assign overloads [(#12627)](https://github.com/stdlib-js/stdlib/pull/12627) _(by Philipp Burckhardt)_
 -   [`a7e07a6`](https://github.com/stdlib-js/stdlib/commit/a7e07a6f17f0974dca43b7bdc0245ce71c28ec86) - **docs:** update namespace table of contents [(#12690)](https://github.com/stdlib-js/stdlib/pull/12690) _(by stdlib-bot)_

sub2ind/docs/types/index.d.ts

@@ -19,10 +19,9 @@
 // TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
-/// <reference types="node"/>
 
 import { ArrayLike } from '@stdlib/types/array';
-import { Order } from '@stdlib/types/ndarray';
+import { Mode, Order } from '@stdlib/types/ndarray';
 
 /**
 * Interface defining function options.
@@ -31,10 +30,10 @@ interface Options {
 	/**
 	* Specifies how to handle subscripts which exceed array dimensions (default: ['throw']).
 	*/
-	mode?: Array<string>;
+	mode?: Mode | Array<Mode>;
 
 	/**
-	* specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major').
+	* Specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major').
 	*/
 	order?: Order;
 }
@@ -57,9 +56,10 @@ interface Options {
 * @param args - subscripts followed by an optional options object
 * @throws first argument must be an array-like object containing nonnegative integers
 * @throws subscripts must be integer valued
+* @throws options argument must be an object
 * @throws must provide valid options
 * @throws must provide subscripts which do not exceed array dimensions
-* @throws number of subscripts much match the number of dimensions
+* @throws number of subscripts must match the number of dimensions
 * @returns linear index
 *
 * @example

sub2ind/docs/types/test.ts

@@ -24,6 +24,7 @@ import subd2ind = require( './index' );
 // The function returns a number...
 {
 	const shape = [ 3, 3, 3 ];
+	subd2ind( shape, 1, 2, 2, { 'mode': 'throw' } ); // $ExpectType number
 	subd2ind( shape, 1, 2, 2, { 'mode': [ 'throw' ] } ); // $ExpectType number
 	subd2ind( shape, 1, 2, 2, { 'order': 'row-major' } ); // $ExpectType number
 }
@@ -65,7 +66,7 @@ import subd2ind = require( './index' );
 	subd2ind( shape, 1, 2, 2, { 'order': ( x: number ): number => x } ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a `mode` option which is not an array of strings...
+// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode or array of recognized modes...
 {
 	const shape = [ 3, 3, 3 ];
 	subd2ind( shape, 1, 2, 2, { 'mode': 'abc' } ); // $ExpectError