Skip to content

Commit b77ddf7

Browse files
committed
fix: replace use of type guards with boolean return type
The type narrowing behavior of type guards makes only sense when the runtime checks match the type guards. For example `value is string` should be used with `typeof value === 'string'` and not with a function that checks for whether a value is a snakecase string. In the latter case, the type guard would incorrectly narrow the type of the value to `never` for a string that is not snakecase.
1 parent 30112b7 commit b77ddf7

File tree

29 files changed

+81
-81
lines changed

29 files changed

+81
-81
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* var bool = isArrayLength( 3.14 );
3737
* // returns false
3838
*/
39-
declare function isArrayLength( value: any ): value is number;
39+
declare function isArrayLength( value: any ): boolean;
4040

4141

4242
// EXPORTS //

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ type Comparison = 'open' | 'closed';
5757
* var bool = isBetween( 3.14, 3.0, 3.14, 'closed', 'open' );
5858
* // returns false
5959
*/
60-
declare function isBetween( value: any, a: any, b: any, left?: Comparison, right?: Comparison ): value is number;
60+
declare function isBetween( value: any, a: any, b: any, left?: Comparison, right?: Comparison ): boolean;
6161

6262

6363
// EXPORTS //

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

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

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

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

8686
/**

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

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

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

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

8686
/**

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface IsEven {
5252
* var bool = isEven( null );
5353
* // returns false
5454
*/
55-
( value: any ): value is number | Number;
55+
( value: any ): boolean;
5656

5757
/**
5858
* Tests if a value is a number primitive that is an even number.
@@ -68,7 +68,7 @@ interface IsEven {
6868
* var bool = isEven.isPrimitive( new Number( -4.0 ) );
6969
* // returns false
7070
*/
71-
isPrimitive( value: any ): value is number;
71+
isPrimitive( value: any ): boolean;
7272

7373
/**
7474
* Tests if a value is a number object that is an even number.
@@ -84,7 +84,7 @@ interface IsEven {
8484
* var bool = isEven.isObject( new Number( 4.0 ) );
8585
* // returns true
8686
*/
87-
isObject( value: any ): value is Number;
87+
isObject( value: any ): boolean;
8888
}
8989

9090
/**

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

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

4949
/**
5050
* Tests if a value is a number primitive having a finite value.
@@ -60,7 +60,7 @@ interface IsFinite {
6060
* var bool = isFinite.isPrimitive( new Number( -3.0 ) );
6161
* // returns false
6262
*/
63-
isPrimitive( value: any ): value is number;
63+
isPrimitive( value: any ): boolean;
6464

6565
/**
6666
* Tests if a value is a number object having a finite value.
@@ -76,7 +76,7 @@ interface IsFinite {
7676
* var bool = isFinite.isObject( new Number( 3.0 ) );
7777
* // returns true
7878
*/
79-
isObject( value: any ): value is Number;
79+
isObject( value: any ): boolean;
8080
}
8181

8282
/**

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

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

4949
/**
5050
* Tests if a value is a number primitive having an infinite value.
@@ -60,7 +60,7 @@ interface IsInfinite {
6060
* var bool = isInfinite.isPrimitive( new Number( -1.0/0.0 ) );
6161
* // returns false
6262
*/
63-
isPrimitive( value: any ): value is number;
63+
isPrimitive( value: any ): boolean;
6464

6565
/**
6666
* Tests if a value is a number object having an infinite value.
@@ -76,7 +76,7 @@ interface IsInfinite {
7676
* var bool = isInfinite.isObject( new Number( 1.0/0.0 ) );
7777
* // returns true
7878
*/
79-
isObject( value: any ): value is Number;
79+
isObject( value: any ): boolean;
8080
}
8181

8282
/**

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

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

4949
/**
5050
* Tests if a value is a number primitive having an integer value.
@@ -60,7 +60,7 @@ interface IsInteger {
6060
* var bool = isInteger.isPrimitive( new Number( -3.0 ) );
6161
* // returns false
6262
*/
63-
isPrimitive( value: any ): value is number;
63+
isPrimitive( value: any ): boolean;
6464

6565
/**
6666
* Tests if a value is a number object having an integer value.
@@ -76,7 +76,7 @@ interface IsInteger {
7676
* var bool = isInteger.isObject( new Number( 3.0 ) );
7777
* // returns true
7878
*/
79-
isObject( value: any ): value is Number;
79+
isObject( value: any ): boolean;
8080
}
8181

8282
/**

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

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

4949
/**
5050
* Tests if a value is a `NaN` number primitive.
@@ -64,7 +64,7 @@ interface IsNaN {
6464
* var bool = isnan.isPrimitive( new Number( NaN ) );
6565
* // returns false
6666
*/
67-
isPrimitive( value: any ): value is number;
67+
isPrimitive( value: any ): boolean;
6868

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

8686
/**

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface isNegativeFinite {
5252
* var bool = isNegativeFinite( -1.0/0.0 );
5353
* // returns false
5454
*/
55-
( value: number | Number ): value is number | Number;
55+
( value: number | Number ): boolean;
5656

5757
/**
5858
* Tests if a value is a number primitive having a finite negative value.
@@ -68,7 +68,7 @@ interface isNegativeFinite {
6868
* var bool = isNegativeFinite.isPrimitive( new Number( -3.0 ) );
6969
* // returns false
7070
*/
71-
isPrimitive( value: number | Number ): value is number;
71+
isPrimitive( value: number | Number ): boolean;
7272

7373
/**
7474
* Tests if a value is a number object having a negative value.
@@ -84,7 +84,7 @@ interface isNegativeFinite {
8484
* var bool = isNegativeFinite.isObject( new Number( -3.0 ) );
8585
* // returns true
8686
*/
87-
isObject( value: number | Number ): value is Number;
87+
isObject( value: number | Number ): boolean;
8888
}
8989

9090
/**

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

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

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

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

8686
/**

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

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

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

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

8686
/**

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface IsNegativeZero {
5252
* var bool = isNegativeZero( null );
5353
* // returns false
5454
*/
55-
( value: any ): value is number | Number;
55+
( value: any ): boolean;
5656

5757
/**
5858
* Tests if a value is a number primitive equal to negative zero.
@@ -68,7 +68,7 @@ interface IsNegativeZero {
6868
* var bool = isNegativeZero.isPrimitive( new Number( -0.0 ) );
6969
* // returns false
7070
*/
71-
isPrimitive( value: any ): value is number;
71+
isPrimitive( value: any ): boolean;
7272

7373
/**
7474
* Tests if a value is a number object having a value equal to negative zero.
@@ -84,7 +84,7 @@ interface IsNegativeZero {
8484
* var bool = isNegativeZero.isObject( new Number( -0.0 ) );
8585
* // returns true
8686
*/
87-
isObject( value: any ): value is Number;
87+
isObject( value: any ): boolean;
8888
}
8989

9090
/**

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface IsNonNegativeFinite {
5252
* var bool = isNonNegativeFinite( null );
5353
* // returns false
5454
*/
55-
( value: any ): value is number | Number;
55+
( value: any ): boolean;
5656

5757
/**
5858
* Tests if a value is a number primitive having a nonnegative finite value.
@@ -76,7 +76,7 @@ interface IsNonNegativeFinite {
7676
* var bool = isNonNegativeFinite( 1.0/0.0 );
7777
* // returns false
7878
*/
79-
isPrimitive( value: any ): value is number;
79+
isPrimitive( value: any ): boolean;
8080

8181
/**
8282
* Tests if a value is a finite number object having a nonnegative value.
@@ -100,7 +100,7 @@ interface IsNonNegativeFinite {
100100
* var bool = isNonNegativeFinite( 1.0/0.0 );
101101
* // returns false
102102
*/
103-
isObject( value: any ): value is Number;
103+
isObject( value: any ): boolean;
104104
}
105105

106106
/**

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 ): value is number | Number;
51+
( value: any ): boolean;
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 ): value is number;
67+
isPrimitive( value: any ): boolean;
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 ): value is Number;
83+
isObject( value: any ): boolean;
8484
}
8585

8686
/**

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 ): value is number | Number;
51+
( value: any ): boolean;
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 ): value is number;
67+
isPrimitive( value: any ): boolean;
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 ): value is Number;
83+
isObject( value: any ): boolean;
8484
}
8585

8686
/**

0 commit comments

Comments
 (0)