Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -2,6 +2,40 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2025-12-29)
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`982208c`](https://github.com/stdlib-js/stdlib/commit/982208cf3c840a5f3ff23378056cd7843dc1e173) - **docs:** update dtype type _(by Athan Reines)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 1 person contributed to this release. Thank you to this contributor:
+
+-   Athan Reines
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.2">
 
 ## 0.2.2 (2024-07-28)

CHANGELOG.md

@@ -4,13 +4,13 @@
 
     Parameters
     ----------
-    dtypeX: string
+    dtypeX: string|DataType
         First input array data type.
 
-    dtypeY: string
+    dtypeY: string|DataType
         Second input array data type.
 
-    dtypeZ: string
+    dtypeZ: string|DataType
         Output array data type.
 
     Returns

dist/index.js.map

@@ -18,6 +18,10 @@
 
 // TypeScript Version: 4.1
 
+/// <reference types="@stdlib/types"/>
+
+import { DataType } from '@stdlib/types/ndarray';
+
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
@@ -30,7 +34,7 @@
 * var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
 * // returns <number>
 */
-declare function binaryBlockSize( dtypeX: string, dtypeY: string, dtypeZ: string ): number;
+declare function binaryBlockSize( dtypeX: DataType, dtypeY: DataType, dtypeZ: DataType ): number;
 
 
 // EXPORTS //

docs/repl.txt

@@ -27,7 +27,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( 'generic', 'generic', 'generic' ); // $ExpectType number
 }
 
-// The compiler throws an error if the function is provided a first argument which is not a string...
+// The compiler throws an error if the function is provided a first argument which is not a valid data type...
 {
 	binaryBlockSize( 123, 'float64', 'float64' ); // $ExpectError
 	binaryBlockSize( true, 'float64', 'float64' ); // $ExpectError
@@ -38,7 +38,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( ( x: number ): number => x, 'float64', 'float64' ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument which is not a string...
+// The compiler throws an error if the function is provided a second argument which is not a valid data type...
 {
 	binaryBlockSize( 'int32', 123, 'int32' ); // $ExpectError
 	binaryBlockSize( 'int32', true, 'int32' ); // $ExpectError
@@ -49,7 +49,7 @@ import binaryBlockSize = require( './index' );
 	binaryBlockSize( 'int32', ( x: number ): number => x, 'int32' ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a third argument which is not a string...
+// The compiler throws an error if the function is provided a third argument which is not a valid data type...
 {
 	binaryBlockSize( 'int32', 'int32', 123 ); // $ExpectError
 	binaryBlockSize( 'int32', 'int32', true ); // $ExpectError

docs/types/index.d.ts

@@ -29,9 +29,9 @@ var defaults = require( './defaults.js' );
 /**
 * Returns a loop block size for multi-dimensional array tiled loops.
 *
-* @param {string} dtypeX - first input array data type
-* @param {string} dtypeY - second input array data type
-* @param {string} dtypeZ - output array data type
+* @param {*} dtypeX - first input array data type
+* @param {*} dtypeY - second input array data type
+* @param {*} dtypeZ - output array data type
 * @returns {integer} block size (in units of elements)
 *
 * @example

docs/types/test.ts

@@ -37,7 +37,8 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/ndarray-base-bytes-per-element": "^0.2.2"
+    "@stdlib/ndarray-base-bytes-per-element": "^0.2.2",
+    "@stdlib/types": "^0.4.3"
   },
   "devDependencies": {
     "@stdlib/array-base-cartesian-square": "^0.2.2",