feat: use type predicates for narrowing

stdlib-js · Jun 28, 2023 · fc5b401 · fc5b401
1 parent 886d7f9
commit fc5b401
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-null-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-null-array/docs/types/index.d.ts
@@ -31,7 +31,7 @@
 * bool = isNullArray( [NaN,2,null] );
 * // returns false
 */
-declare function isNullArray( value: any ): boolean;
+declare function isNullArray( value: any ): value is ArrayLike<null>;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-null/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-null/docs/types/index.d.ts
@@ -31,7 +31,7 @@
 * bool = isNull( true );
 * // returns false
 */
-declare function isNull( value: any ): boolean;
+declare function isNull( value: any ): value is null;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-number-array/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface IsNumberArray {
 	* var bool = isNumberArray( [ -3.0, '3.0' ] );
 	* // returns false
 	*/
-	( value: any ): boolean;
+	( value: any ): value is ArrayLike<number | Number>;
 
 	/**
 	* Tests if a value is an array-like object containing only number primitives.
@@ -56,7 +56,7 @@ interface IsNumberArray {
 	* var bool = isNumberArray.primitives( [ -3.0, new Number(-1.0) ] );
 	* // returns false
 	*/
-	primitives( value: any ): boolean;
+	primitives( value: any ): value is ArrayLike<number>;
 
 	/**
 	* Tests if a value is an array-like object containing only number objects.
@@ -76,7 +76,7 @@ interface IsNumberArray {
 	* var bool = isNumberArray.objects( [ 3.0, new Number(-1.0) ] );
 	* // returns false
 	*/
-	objects( value: any ): boolean;
+	objects( value: any ): value is ArrayLike<Number>;
 }
 
 /**

diff --git a/lib/node_modules/@stdlib/assert/is-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-number/docs/types/index.d.ts
@@ -44,7 +44,7 @@ interface IsNumber {
 	* var bool = isNumber( null );
 	* // returns false
 	*/
-	( value: any ): boolean;
+	( value: any ): value is number | Number;
 
 	/**
 	* Tests if a value is a number primitive.
@@ -64,7 +64,7 @@ interface IsNumber {
 	* var bool = isNumber.isPrimitive( new Number( 3.14 ) );
 	* // returns false
 	*/
-	isPrimitive( value: any ): boolean;
+	isPrimitive( value: any ): value is number;
 
 	/**
 	* Tests if a value is a number object.
@@ -80,7 +80,7 @@ interface IsNumber {
 	* var bool = isNumber.isObject( new Number( 3.14 ) );
 	* // returns true
 	*/
-	isObject( value: any ): boolean;
+	isObject( value: any ): value is Number;
 }
 
 /**

diff --git a/lib/node_modules/@stdlib/assert/is-numeric-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-numeric-array/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * bool = isNumericArray( [ '1', '2', '3' ] );
 * // returns false
 */
-declare function isNumericArray( v: any ): boolean;
+declare function isNumericArray( v: any ): v is ArrayLike<number>;
 
 
 // EXPORTS //