Skip to content

Commit fc5b401

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

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* bool = isNullArray( [NaN,2,null] );
3232
* // returns false
3333
*/
34-
declare function isNullArray( value: any ): boolean;
34+
declare function isNullArray( value: any ): value is ArrayLike<null>;
3535

3636

3737
// EXPORTS //

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* bool = isNull( true );
3232
* // returns false
3333
*/
34-
declare function isNull( value: any ): boolean;
34+
declare function isNull( value: any ): value is null;
3535

3636

3737
// EXPORTS //

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface IsNumberArray {
3636
* var bool = isNumberArray( [ -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 number primitives.
@@ -56,7 +56,7 @@ interface IsNumberArray {
5656
* var bool = isNumberArray.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.
@@ -76,7 +76,7 @@ interface IsNumberArray {
7676
* var bool = isNumberArray.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-number/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ interface IsNumber {
4444
* var bool = isNumber( null );
4545
* // returns false
4646
*/
47-
( value: any ): boolean;
47+
( value: any ): value is number | Number;
4848

4949
/**
5050
* Tests if a value is a number primitive.
@@ -64,7 +64,7 @@ interface IsNumber {
6464
* var bool = isNumber.isPrimitive( new Number( 3.14 ) );
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.
@@ -80,7 +80,7 @@ interface IsNumber {
8080
* var bool = isNumber.isObject( new Number( 3.14 ) );
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-numeric-array/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* bool = isNumericArray( [ '1', '2', '3' ] );
3535
* // returns false
3636
*/
37-
declare function isNumericArray( v: any ): boolean;
37+
declare function isNumericArray( v: any ): v is ArrayLike<number>;
3838

3939

4040
// EXPORTS //

0 commit comments

Comments
 (0)