Skip to content

Commit 886d7f9

Browse files
committed
feat: use type predicates for narrowing
1 parent 3aba9d6 commit 886d7f9

File tree

8 files changed

+24
-24
lines changed

8 files changed

+24
-24
lines changed

lib/node_modules/@stdlib/assert/is-nonnegative-integer-array/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface IsNonNegativeIntegerArray {
3636
* var bool = isNonNegativeIntegerArray( [ 3.0, '3.0' ] );
3737
* // returns false
3838
*/
39-
( value: any ): boolean;
39+
( value: any ): value is ArrayLike<number | Number>;
4040

4141
/**
4242
* Tests if a value is an array-like object containing only nonnegative primitive integer values.
@@ -52,7 +52,7 @@ interface IsNonNegativeIntegerArray {
5252
* var bool = isNonNegativeIntegerArray.primitives( [ 3.0, new Number(1.0) ] );
5353
* // returns false
5454
*/
55-
primitives( value: any ): boolean;
55+
primitives( value: any ): value is ArrayLike<number>;
5656

5757
/**
5858
* Tests if a value is an array-like object containing only number objects having nonnegative integer values.
@@ -68,7 +68,7 @@ interface IsNonNegativeIntegerArray {
6868
* var bool = isNonNegativeIntegerArray.objects( [ 1.0, 0.0, 10.0 ] );
6969
* // returns false
7070
*/
71-
objects( value: any ): boolean;
71+
objects( value: any ): value is ArrayLike<Number>;
7272
}
7373

7474
/**

lib/node_modules/@stdlib/assert/is-nonnegative-integer/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IsNonNegativeInteger {
4848
* var bool = isNonNegativeInteger( null );
4949
* // returns false
5050
*/
51-
( value: any ): boolean;
51+
( value: any ): value is number | Number;
5252

5353
/**
5454
* Tests if a value is a number primitive having a nonnegative integer value.
@@ -64,7 +64,7 @@ interface IsNonNegativeInteger {
6464
* var bool = isNonNegativeInteger.isPrimitive( new Number( 3.0 ) );
6565
* // returns false
6666
*/
67-
isPrimitive( value: any ): boolean;
67+
isPrimitive( value: any ): value is number;
6868

6969
/**
7070
* Tests if a value is a number object having a nonnegative integer value.
@@ -80,7 +80,7 @@ interface IsNonNegativeInteger {
8080
* var bool = isNonNegativeInteger.isObject( new Number( 3.0 ) );
8181
* // returns true
8282
*/
83-
isObject( value: any ): boolean;
83+
isObject( value: any ): value is Number;
8484
}
8585

8686
/**

lib/node_modules/@stdlib/assert/is-nonnegative-number-array/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface IsNonNegativeNumberArray {
3636
* var bool = isNonNegativeNumberArray( [ 3.0, '3.0' ] );
3737
* // returns false
3838
*/
39-
( value: any ): boolean;
39+
( value: any ): value is ArrayLike<number | Number>;
4040

4141
/**
4242
* Tests if a value is an array-like object containing only nonnegative primitive number values.
@@ -52,7 +52,7 @@ interface IsNonNegativeNumberArray {
5252
* var bool = isNonNegativeNumberArray.primitives( [ 3.0, new Number(1.0) ] );
5353
* // returns false
5454
*/
55-
primitives( value: any ): boolean;
55+
primitives( value: any ): value is ArrayLike<number>;
5656

5757
/**
5858
* Tests if a value is an array-like object containing only number objects having nonnegative number values.
@@ -68,7 +68,7 @@ interface IsNonNegativeNumberArray {
6868
* var bool = isNonNegativeNumberArray.objects( [ 1.0, 0.0, 10.0 ] );
6969
* // returns false
7070
*/
71-
objects( value: any ): boolean;
71+
objects( value: any ): value is ArrayLike<Number>;
7272
}
7373

7474
/**

lib/node_modules/@stdlib/assert/is-nonnegative-number/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IsNonNegativeNumber {
4848
* var bool = isNonNegativeNumber( null );
4949
* // returns false
5050
*/
51-
( value: any ): boolean;
51+
( value: any ): value is number | Number;
5252

5353
/**
5454
* Tests if a value is a number primitive having a nonnegative value.
@@ -64,7 +64,7 @@ interface IsNonNegativeNumber {
6464
* var bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) );
6565
* // returns false
6666
*/
67-
isPrimitive( value: any ): boolean;
67+
isPrimitive( value: any ): value is number;
6868

6969
/**
7070
* Tests if a value is a number object having a nonnegative value.
@@ -80,7 +80,7 @@ interface IsNonNegativeNumber {
8080
* var bool = isNonNegativeNumber.isObject( new Number( 3.0 ) );
8181
* // returns true
8282
*/
83-
isObject( value: any ): boolean;
83+
isObject( value: any ): value is Number;
8484
}
8585

8686
/**

lib/node_modules/@stdlib/assert/is-nonpositive-integer-array/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface IsNonPositiveIntegerArray {
3636
* var bool = isNonPositiveIntegerArray( [ -3.0, '-3.0' ] );
3737
* // returns false
3838
*/
39-
( value: any ): boolean;
39+
( value: any ): value is ArrayLike<number | Number>;
4040

4141
/**
4242
* Tests if a value is an array-like object containing only nonpositive primitive integer values.
@@ -56,7 +56,7 @@ interface IsNonPositiveIntegerArray {
5656
* var bool = isNonPositiveIntegerArray.primitives( [ -3.0, new Number(-1.0) ] );
5757
* // returns false
5858
*/
59-
primitives( value: any ): boolean;
59+
primitives( value: any ): value is ArrayLike<number>;
6060

6161
/**
6262
* Tests if a value is an array-like object containing only number objects having nonpositive integer values.
@@ -76,7 +76,7 @@ interface IsNonPositiveIntegerArray {
7676
* var bool = isNonPositiveIntegerArray.objects( [ -3.0, new Number(-1.0) ] );
7777
* // returns false
7878
*/
79-
objects( value: any ): boolean;
79+
objects( value: any ): value is ArrayLike<Number>;
8080
}
8181

8282
/**

lib/node_modules/@stdlib/assert/is-nonpositive-integer/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IsNonPositiveInteger {
4848
* var bool = isNonPositiveInteger( null );
4949
* // returns false
5050
*/
51-
( value: any ): boolean;
51+
( value: any ): value is number | Number;
5252

5353
/**
5454
* Tests if a value is a number primitive having a nonpositive integer value.
@@ -64,7 +64,7 @@ interface IsNonPositiveInteger {
6464
* var bool = isNonPositiveInteger.isPrimitive( new Number( -3.0 ) );
6565
* // returns false
6666
*/
67-
isPrimitive( value: any ): boolean;
67+
isPrimitive( value: any ): value is number;
6868

6969
/**
7070
* Tests if a value is a number object having a nonpositive integer value.
@@ -80,7 +80,7 @@ interface IsNonPositiveInteger {
8080
* var bool = isNonPositiveInteger.isObject( new Number( -3.0 ) );
8181
* // returns true
8282
*/
83-
isObject( value: any ): boolean;
83+
isObject( value: any ): value is Number;
8484
}
8585

8686
/**

lib/node_modules/@stdlib/assert/is-nonpositive-number-array/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface IsNonPositiveNumberArray {
3636
* var bool = isNonPositiveNumberArray( [ -3.0, '-3.0' ] );
3737
* // returns false
3838
*/
39-
( value: any ): boolean;
39+
( value: any ): value is ArrayLike<number | Number>;
4040

4141
/**
4242
* Tests if a value is an array-like object containing only nonpositive primitive integer values.
@@ -56,7 +56,7 @@ interface IsNonPositiveNumberArray {
5656
* var bool = isNonPositiveNumberArray.primitives( [ -3.0, new Number(-1.0) ] );
5757
* // returns false
5858
*/
59-
primitives( value: any ): boolean;
59+
primitives( value: any ): value is ArrayLike<number>;
6060

6161
/**
6262
* Tests if a value is an array-like object containing only number objects having nonpositive integer values.
@@ -76,7 +76,7 @@ interface IsNonPositiveNumberArray {
7676
* var bool = isNonPositiveNumberArray.objects( [ -3.0, new Number(-1.0) ] );
7777
* // returns false
7878
*/
79-
objects( value: any ): boolean;
79+
objects( value: any ): value is ArrayLike<Number>;
8080
}
8181

8282
/**

lib/node_modules/@stdlib/assert/is-nonpositive-number/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IsNonPositiveNumber {
4848
* var bool = isNonPositiveNumber( null );
4949
* // returns false
5050
*/
51-
( value: any ): boolean;
51+
( value: any ): value is number | Number;
5252

5353
/**
5454
* Tests if a value is a number primitive having a nonpositive value.
@@ -64,7 +64,7 @@ interface IsNonPositiveNumber {
6464
* var bool = isNonPositiveNumber.isPrimitive( new Number( -3.0 ) );
6565
* // returns false
6666
*/
67-
isPrimitive( value: any ): boolean;
67+
isPrimitive( value: any ): value is number;
6868

6969
/**
7070
* Tests if a value is a number object having a nonpositive value.
@@ -80,7 +80,7 @@ interface IsNonPositiveNumber {
8080
* var bool = isNonPositiveNumber.isObject( new Number( -3.0 ) );
8181
* // returns true
8282
*/
83-
isObject( value: any ): boolean;
83+
isObject( value: any ): value is Number;
8484
}
8585

8686
/**

0 commit comments

Comments
 (0)