docs: update parameter types

kgryte · kgryte · commit b5edd5182fea · 2025-12-29T01:45:44.000-08:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/random/tools/binary/lib/main.js b/lib/node_modules/@stdlib/random/tools/binary/lib/main.js
@@ -368,7 +368,7 @@ function Random( prng, idtypes, odtypes, policies, options ) {
 * @param {*} [options.dtype] - output ndarray data type
 * @param {string} [options.order] - memory layout (either row-major or column-major)
 * @param {string} [options.mode] - specifies how to handle indices which exceed ndarray dimensions
-* @param {StringArray} [options.submode] - specifies how to handle subscripts which exceed ndarray dimensions on a per dimension basis
+* @param {ArrayLikeObject<string>} [options.submode] - specifies how to handle subscripts which exceed ndarray dimensions on a per dimension basis
 * @param {boolean} [options.readonly] - boolean indicating whether an ndarray should be read-only
 * @throws {TypeError} first argument must be a valid shape
 * @throws {TypeError} must provide valid PRNG parameters
diff --git a/lib/node_modules/@stdlib/random/tools/binary/lib/validate.js b/lib/node_modules/@stdlib/random/tools/binary/lib/validate.js
@@ -24,6 +24,7 @@ var isObject = require( '@stdlib/assert/is-plain-object' );
 var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 var contains = require( '@stdlib/array/base/assert/contains' );
 var join = require( '@stdlib/array/base/join' );
+var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
 var format = require( '@stdlib/string/format' );
 
 
@@ -34,12 +35,12 @@ var format = require( '@stdlib/string/format' );
 *
 * @private
 * @param {Object} opts - destination object
-* @param {StringArray} dtypes - list of supported output data types
+* @param {Array<string>} dtypes - list of supported output data types
 * @param {Options} options - function options
-* @param {string} [options.dtype] - array data type
+* @param {*} [options.dtype] - array data type
 * @param {string} [options.order] - memory layout (either row-major or column-major)
 * @param {string} [options.mode] - specifies how to handle indices which exceed array dimensions
-* @param {StringArray} [options.submode] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
+* @param {ArrayLikeObject<string>} [options.submode] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
 * @param {boolean} [options.readonly] - boolean indicating whether an array should be read-only
 * @returns {(Error|null)} null or an error object
 *
@@ -61,7 +62,7 @@ function validate( opts, dtypes, options ) {
 	}
 	if ( hasOwnProp( options, 'dtype' ) ) {
 		opts.dtype = options.dtype;
-		if ( !contains( dtypes, opts.dtype ) ) {
+		if ( !contains( dtypes, resolveStr( opts.dtype ) ) ) {
 			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', join( dtypes, '", "' ), opts.dtype ) );
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ var isObject = require( '@stdlib/assert/is-plain-object' );`
`24`	`24`	`var hasOwnProp = require( '@stdlib/assert/has-own-property' );`
`25`	`25`	`var contains = require( '@stdlib/array/base/assert/contains' );`
`26`	`26`	`var join = require( '@stdlib/array/base/join' );`
	`27`	`+var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );`
`27`	`28`	`var format = require( '@stdlib/string/format' );`
`28`	`29`
`29`	`30`
`@@ -34,12 +35,12 @@ var format = require( '@stdlib/string/format' );`
`34`	`35`	`*`
`35`	`36`	`* @private`
`36`	`37`	`* @param {Object} opts - destination object`
`37`		`-* @param {StringArray} dtypes - list of supported output data types`
	`38`	`+* @param {Array<string>} dtypes - list of supported output data types`
`38`	`39`	`* @param {Options} options - function options`
`39`		`-* @param {string} [options.dtype] - array data type`
	`40`	`+* @param {*} [options.dtype] - array data type`
`40`	`41`	`* @param {string} [options.order] - memory layout (either row-major or column-major)`
`41`	`42`	`* @param {string} [options.mode] - specifies how to handle indices which exceed array dimensions`
`42`		`-* @param {StringArray} [options.submode] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis`
	`43`	`+* @param {ArrayLikeObject<string>} [options.submode] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis`
`43`	`44`	`* @param {boolean} [options.readonly] - boolean indicating whether an array should be read-only`
`44`	`45`	`* @returns {(Error\|null)} null or an error object`
`45`	`46`	`*`
`@@ -61,7 +62,7 @@ function validate( opts, dtypes, options ) {`
`61`	`62`	`}`
`62`	`63`	`if ( hasOwnProp( options, 'dtype' ) ) {`
`63`	`64`	`opts.dtype = options.dtype;`
`64`		`- if ( !contains( dtypes, opts.dtype ) ) {`
	`65`	`+ if ( !contains( dtypes, resolveStr( opts.dtype ) ) ) {`
`65`	`66`	return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', join( dtypes, '", "' ), opts.dtype ) );
`66`	`67`	`}`
`67`	`68`	`}`