docs: update dtype type

kgryte · kgryte · commit ff435c01d291 · 2025-12-29T00:17:57.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/stats/cumax/lib/main.js b/lib/node_modules/@stdlib/stats/cumax/lib/main.js
@@ -60,7 +60,7 @@ var table = {
 * @param {ndarray} x - input ndarray
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/cumin/lib/main.js b/lib/node_modules/@stdlib/stats/cumin/lib/main.js
@@ -60,7 +60,7 @@ var table = {
 * @param {ndarray} x - input ndarray
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/max-by/lib/main.js b/lib/node_modules/@stdlib/stats/max-by/lib/main.js
@@ -49,7 +49,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @param {Function} clbk - callback function
 * @param {*} [thisArg] - callback function execution context
 * @throws {TypeError} first argument must be an ndarray-like object
diff --git a/lib/node_modules/@stdlib/stats/max/lib/main.js b/lib/node_modules/@stdlib/stats/max/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/maxabs/lib/main.js b/lib/node_modules/@stdlib/stats/maxabs/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js b/lib/node_modules/@stdlib/stats/maxsorted/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/mean/lib/main.js b/lib/node_modules/@stdlib/stats/mean/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meankbn/lib/main.js b/lib/node_modules/@stdlib/stats/meankbn/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meankbn2/lib/main.js b/lib/node_modules/@stdlib/stats/meankbn2/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meanors/lib/main.js b/lib/node_modules/@stdlib/stats/meanors/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meanpn/lib/main.js b/lib/node_modules/@stdlib/stats/meanpn/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meanpw/lib/main.js b/lib/node_modules/@stdlib/stats/meanpw/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/meanwd/lib/main.js b/lib/node_modules/@stdlib/stats/meanwd/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/mediansorted/lib/main.js b/lib/node_modules/@stdlib/stats/mediansorted/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/midrange/lib/main.js b/lib/node_modules/@stdlib/stats/midrange/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/min-by/lib/main.js b/lib/node_modules/@stdlib/stats/min-by/lib/main.js
@@ -49,7 +49,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @param {Function} clbk - callback function
 * @param {*} [thisArg] - callback function execution context
 * @throws {TypeError} first argument must be an ndarray-like object
diff --git a/lib/node_modules/@stdlib/stats/min/lib/main.js b/lib/node_modules/@stdlib/stats/min/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/minabs/lib/main.js b/lib/node_modules/@stdlib/stats/minabs/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/minsorted/lib/main.js b/lib/node_modules/@stdlib/stats/minsorted/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmax-by/lib/main.js b/lib/node_modules/@stdlib/stats/nanmax-by/lib/main.js
@@ -49,7 +49,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @param {Function} clbk - callback function
 * @param {*} [thisArg] - callback function execution context
 * @throws {TypeError} first argument must be an ndarray-like object
diff --git a/lib/node_modules/@stdlib/stats/nanmax/lib/main.js b/lib/node_modules/@stdlib/stats/nanmax/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmaxabs/lib/main.js b/lib/node_modules/@stdlib/stats/nanmaxabs/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmean/lib/main.js b/lib/node_modules/@stdlib/stats/nanmean/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmeanors/lib/main.js b/lib/node_modules/@stdlib/stats/nanmeanors/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmeanpn/lib/main.js b/lib/node_modules/@stdlib/stats/nanmeanpn/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmeanwd/lib/main.js b/lib/node_modules/@stdlib/stats/nanmeanwd/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanmin-by/lib/main.js b/lib/node_modules/@stdlib/stats/nanmin-by/lib/main.js
@@ -49,7 +49,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @param {Function} clbk - callback function
 * @param {*} [thisArg] - callback function execution context
 * @throws {TypeError} first argument must be an ndarray-like object
diff --git a/lib/node_modules/@stdlib/stats/nanmin/lib/main.js b/lib/node_modules/@stdlib/stats/nanmin/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanminabs/lib/main.js b/lib/node_modules/@stdlib/stats/nanminabs/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/nanrange-by/lib/main.js b/lib/node_modules/@stdlib/stats/nanrange-by/lib/main.js
@@ -49,7 +49,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @param {Function} clbk - callback function
 * @param {*} [thisArg] - callback function execution context
 * @throws {TypeError} first argument must be an ndarray-like object
diff --git a/lib/node_modules/@stdlib/stats/nanrange/lib/main.js b/lib/node_modules/@stdlib/stats/nanrange/lib/main.js
@@ -59,7 +59,7 @@ var table = {
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
 * @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
-* @param {string} [options.dtype] - output ndarray data type
+* @param {*} [options.dtype] - output ndarray data type
 * @throws {TypeError} first argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {RangeError} dimension indices must not exceed input ndarray bounds
diff --git a/lib/node_modules/@stdlib/stats/range-by/lib/main.js b/lib/node_modules/@stdlib/stats/range-by/lib/main.js
diff --git a/lib/node_modules/@stdlib/stats/range/lib/main.js b/lib/node_modules/@stdlib/stats/range/lib/main.js
