feat: use type predicates for narrowing

stdlib-js · Jun 28, 2023 · 196225d · kgryte · Jun 28, 2023 · 196225d
1 parent 757db5e
commit 196225d
Show file tree

Hide file tree

Showing 14 changed files with 30 additions and 30 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-pascalcase/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-pascalcase/docs/types/index.d.ts
@@ -40,7 +40,7 @@
 * var bool = isPascalcase( null );
 * // returns false
 */
-declare function isPascalcase( value: any ): boolean;
+declare function isPascalcase( value: any ): value is string;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-plain-object-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-plain-object-array/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * bool = isPlainObjectArray( [ {}, '3.0' ] );
 * // returns false
 */
-declare function isPlainObjectArray( value: any ): boolean;
+declare function isPlainObjectArray( value: any ): value is ArrayLike<object>;
 
 
 // EXPORTS //

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

diff --git a/lib/node_modules/@stdlib/assert/is-positive-integer-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-positive-integer-array/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface IsPositiveIntegerArray {
 	* var bool = isPositiveIntegerArray( [ 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 positive primitive integer values.
@@ -52,7 +52,7 @@ interface IsPositiveIntegerArray {
 	* var bool = isPositiveIntegerArray.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 having positive integer values.
@@ -68,7 +68,7 @@ interface IsPositiveIntegerArray {
 	* var bool = isPositiveIntegerArray.objects( [ 1.0, 2.0, 10.0 ] );
 	* // returns false
 	*/
-	objects( value: any ): boolean;
+	objects( value: any ): value is ArrayLike<Number>;
 }
 
 /**

diff --git a/lib/node_modules/@stdlib/assert/is-positive-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-positive-integer/docs/types/index.d.ts
@@ -52,7 +52,7 @@ interface IsPositiveInteger {
 	* var bool = isPositiveInteger( null );
 	* // returns false
 	*/
-	( value: any ): boolean;
+	( value: any ): value is number | Number;
 
 	/**
 	* Tests if a value is a number primitive having a positive integer value.
@@ -68,7 +68,7 @@ interface IsPositiveInteger {
 	* var bool = isPositiveInteger.isPrimitive( new Number( 3.0 ) );
 	* // returns false
 	*/
-	isPrimitive( value: any ): boolean;
+	isPrimitive( value: any ): value is number;
 
 	/**
 	* Tests if a value is a number object having a positive integer value.
@@ -84,7 +84,7 @@ interface IsPositiveInteger {
 	* var bool = isPositiveInteger.isObject( new Number( 3.0 ) );
 	* // returns true
 	*/
-	isObject( value: any ): boolean;
+	isObject( value: any ): value is Number;
 }
 
 /**

diff --git a/lib/node_modules/@stdlib/assert/is-positive-number-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-positive-number-array/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface IsPositiveNumberArray {
 	* var bool = isPositiveNumberArray( [ 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 positive primitive number values.
@@ -52,7 +52,7 @@ interface IsPositiveNumberArray {
 	* var bool = isPositiveNumberArray.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 having positive number values.
@@ -68,7 +68,7 @@ interface IsPositiveNumberArray {
 	* var bool = isPositiveNumberArray.objects( [ 1.0, 2.7, 10.0 ] );
 	* // returns false
 	*/
-	objects( value: any ): boolean;
+	objects( value: any ): value is ArrayLike<Number>;
 }
 
 /**

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

diff --git a/lib/node_modules/@stdlib/assert/is-positive-zero/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-positive-zero/docs/types/index.d.ts
@@ -52,7 +52,7 @@ interface IsPositiveZero {
 	* var bool = isPositiveZero( null );
 	* // returns false
 	*/
-	( value: any ): boolean;
+	( value: any ): value is number | Number;
 
 	/**
 	* Tests if a value is a number primitive equal to positive zero.
@@ -68,7 +68,7 @@ interface IsPositiveZero {
 	* var bool = isPositiveZero.isPrimitive( new Number( 0.0 ) );
 	* // returns false
 	*/
-	isPrimitive( value: any ): boolean;
+	isPrimitive( value: any ): value is number;
 
 	/**
 	* Tests if a value is a number object having a value equal to positive zero.
@@ -84,7 +84,7 @@ interface IsPositiveZero {
 	* var bool = isPositiveZero.isObject( new Number( 0.0 ) );
 	* // returns true
 	*/
-	isObject( value: any ): boolean;
+	isObject( value: any ): value is Number;
 }
 
 /**

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

diff --git a/lib/node_modules/@stdlib/assert/is-primitive-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-primitive-array/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * bool = isPrimitiveArray( [ new String('abc'), '3.0' ] );
 * // returns false
 */
-declare function isPrimitiveArray( value: any ): boolean;
+declare function isPrimitiveArray( value: any ): value is Array<any>;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-primitive/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-primitive/docs/types/index.d.ts
@@ -32,7 +32,7 @@
 * var bool = isPrimitive( {} );
 * // returns false
 */
-declare function isPrimitive( value: any ): boolean;
+declare function isPrimitive( value: any ): value is null | undefined | string | boolean | number | symbol;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-probability-array/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface IsProbabilityArray {
 	* var bool = isProbabilityArray( [ 0.3, '0.3' ] );
 	* // returns false
 	*/
-	( value: any ): boolean;
+	( value: any ): value is ArrayLike<number | Number>;
 
 	/**
 	* Tests if a value is an array-like object containing only primitive probabilities.
@@ -52,7 +52,7 @@ interface IsProbabilityArray {
 	* var bool = isProbabilityArray.primitives( [ 0.3, new Number(0.1) ] );
 	* // 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 having probability values.
@@ -68,7 +68,7 @@ interface IsProbabilityArray {
 	* var bool = isProbabilityArray.objects( [ 0.1, 0.2, 0.3 ] );
 	* // returns false
 	*/
-	objects( value: any ): boolean;
+	objects( value: any ): value is ArrayLike<Number>;
 }
 
 /**

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

diff --git a/lib/node_modules/@stdlib/assert/is-property-key/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-property-key/docs/types/index.d.ts
@@ -46,7 +46,7 @@
 * var bool = isPropertyKey( [] );
 * // returns false
 */
-declare function isPropertyKey( value: any ): boolean;
+declare function isPropertyKey( value: any ): value is PropertyKey;
 
 
 // EXPORTS //