feat: improve type specificity of return type and update examples

kgryte · kgryte · commit e90a075eea2d · 2023-12-31T02:53:07.000-08:00
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/README.md b/lib/node_modules/@stdlib/ndarray/dtypes/README.md
@@ -109,7 +109,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
 var dtypes = require( '@stdlib/ndarray/dtypes' );
 
 var DTYPES = dtypes();
-var bool;
 
 function isdtype( str ) {
     if ( indexOf( DTYPES, str ) === -1 ) {
@@ -118,7 +117,7 @@ function isdtype( str ) {
     return true;
 }
 
-bool = isdtype( 'float64' );
+var bool = isdtype( 'float64' );
 // returns true
 
 bool = isdtype( 'int16' );
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/index.d.ts
@@ -18,10 +18,9 @@
 
 // TypeScript Version: 4.1
 
-/**
-* Data type kind.
-*/
-type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point' | 'complex_floating_point' | 'integer' | 'signed_integer' | 'unsigned_integer';
+/// <reference types="@stdlib/types"/>
+
+import { DataType, DataTypeKind } from '@stdlib/types/ndarray';
 
 /**
 * Returns a list of ndarray data types.
@@ -55,7 +54,7 @@ type Kind = 'all' | 'numeric' | 'real' | 'floating_point' | 'real_floating_point
 * var list = dtypes( 'floating_point' );
 * // returns [...]
 */
-declare function dtypes( kind?: Kind ): Array<string>;
+declare function dtypes( kind?: DataTypeKind ): Array<DataType>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/dtypes/docs/types/test.ts
@@ -21,10 +21,10 @@ import dtypes = require( './index' );
 
 // TESTS //
 
-// The function returns an array of strings...
+// The function returns an array of data types...
 {
-	dtypes(); // $ExpectType string[]
-	dtypes( 'floating_point' ); // $ExpectType string[]
+	dtypes(); // $ExpectType DataType[]
+	dtypes( 'floating_point' ); // $ExpectType DataType[]
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
diff --git a/lib/node_modules/@stdlib/ndarray/dtypes/examples/index.js b/lib/node_modules/@stdlib/ndarray/dtypes/examples/index.js
@@ -22,7 +22,6 @@ var indexOf = require( '@stdlib/utils/index-of' );
 var dtypes = require( './../lib' );
 
 var DTYPES = dtypes();
-var bool;
 
 function isdtype( str ) {
 	if ( indexOf( DTYPES, str ) === -1 ) {
@@ -31,7 +30,7 @@ function isdtype( str ) {
 	return true;
 }
 
-bool = isdtype( 'float64' );
+var bool = isdtype( 'float64' );
 console.log( bool );
 // => true
 

Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ import dtypes = require( './index' );`
`21`	`21`
`22`	`22`	`// TESTS //`
`23`	`23`
`24`		`-// The function returns an array of strings...`
	`24`	`+// The function returns an array of data types...`
`25`	`25`	`{`
`26`		`- dtypes(); // $ExpectType string[]`
`27`		`- dtypes( 'floating_point' ); // $ExpectType string[]`
	`26`	`+ dtypes(); // $ExpectType DataType[]`
	`27`	`+ dtypes( 'floating_point' ); // $ExpectType DataType[]`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`// The compiler throws an error if the function is provided an unsupported number of arguments...`