From b77ddf74c62c7031c7a542d8a661a51e19fd6ebd Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 27 Feb 2024 20:33:40 -0500 Subject: [PATCH] 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. --- .../@stdlib/assert/is-array-length/docs/types/index.d.ts | 2 +- .../@stdlib/assert/is-between/docs/types/index.d.ts | 2 +- .../@stdlib/assert/is-composite/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-cube-number/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-even/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-finite/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-infinite/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-integer/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-nan/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-negative-finite/docs/types/index.d.ts | 6 +++--- .../assert/is-negative-integer/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-negative-number/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-negative-zero/docs/types/index.d.ts | 6 +++--- .../assert/is-nonnegative-finite/docs/types/index.d.ts | 6 +++--- .../assert/is-nonnegative-integer/docs/types/index.d.ts | 6 +++--- .../assert/is-nonnegative-number/docs/types/index.d.ts | 6 +++--- .../assert/is-nonpositive-finite/docs/types/index.d.ts | 6 +++--- .../assert/is-nonpositive-integer/docs/types/index.d.ts | 6 +++--- .../assert/is-nonpositive-number/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-odd/docs/types/index.d.ts | 6 +++--- .../assert/is-positive-integer/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-positive-number/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-positive-zero/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-prime/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-probability/docs/types/index.d.ts | 6 +++--- .../@stdlib/assert/is-safe-integer/docs/types/index.d.ts | 6 +++--- .../is-square-triangular-number/docs/types/index.d.ts | 6 +++--- .../assert/is-triangular-number/docs/types/index.d.ts | 6 +++--- .../assert/is-typed-array-length/docs/types/index.d.ts | 2 +- 29 files changed, 81 insertions(+), 81 deletions(-) diff --git a/lib/node_modules/@stdlib/assert/is-array-length/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-length/docs/types/index.d.ts index 5792a405553..7738708de4a 100644 --- a/lib/node_modules/@stdlib/assert/is-array-length/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-array-length/docs/types/index.d.ts @@ -36,7 +36,7 @@ * var bool = isArrayLength( 3.14 ); * // returns false */ -declare function isArrayLength( value: any ): value is number; +declare function isArrayLength( value: any ): boolean; // EXPORTS // diff --git a/lib/node_modules/@stdlib/assert/is-between/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-between/docs/types/index.d.ts index 474aab923bc..48c82fac9b0 100644 --- a/lib/node_modules/@stdlib/assert/is-between/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-between/docs/types/index.d.ts @@ -57,7 +57,7 @@ type Comparison = 'open' | 'closed'; * var bool = isBetween( 3.14, 3.0, 3.14, 'closed', 'open' ); * // returns false */ -declare function isBetween( value: any, a: any, b: any, left?: Comparison, right?: Comparison ): value is number; +declare function isBetween( value: any, a: any, b: any, left?: Comparison, right?: Comparison ): boolean; // EXPORTS // diff --git a/lib/node_modules/@stdlib/assert/is-composite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-composite/docs/types/index.d.ts index deb1a46254b..a9ba04be1b9 100644 --- a/lib/node_modules/@stdlib/assert/is-composite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-composite/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsComposite { * var bool = isComposite( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a value which is a composite number. @@ -64,7 +64,7 @@ interface IsComposite { * var bool = isComposite.isPrimitive( new Number( 4.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value which is a composite number. @@ -80,7 +80,7 @@ interface IsComposite { * var bool = isComposite.isObject( new Number( 4.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-cube-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-cube-number/docs/types/index.d.ts index 98db0524d3b..925849b9e00 100644 --- a/lib/node_modules/@stdlib/assert/is-cube-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-cube-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsCubeNumber { * var bool = isCubeNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a value which is a cube number. @@ -64,7 +64,7 @@ interface IsCubeNumber { * var bool = isCubeNumber.isPrimitive( new Number( 8.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value which is a cube number. @@ -80,7 +80,7 @@ interface IsCubeNumber { * var bool = isCubeNumber.isObject( new Number( 8.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-even/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-even/docs/types/index.d.ts index 6b144c5041b..c26be3b7aad 100644 --- a/lib/node_modules/@stdlib/assert/is-even/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-even/docs/types/index.d.ts @@ -52,7 +52,7 @@ interface IsEven { * var bool = isEven( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive that is an even number. @@ -68,7 +68,7 @@ interface IsEven { * var bool = isEven.isPrimitive( new Number( -4.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object that is an even number. @@ -84,7 +84,7 @@ interface IsEven { * var bool = isEven.isObject( new Number( 4.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-finite/docs/types/index.d.ts index 8c6250ef9c2..7a715a72539 100644 --- a/lib/node_modules/@stdlib/assert/is-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-finite/docs/types/index.d.ts @@ -44,7 +44,7 @@ interface IsFinite { * var bool = isFinite( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a finite value. @@ -60,7 +60,7 @@ interface IsFinite { * var bool = isFinite.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a finite value. @@ -76,7 +76,7 @@ interface IsFinite { * var bool = isFinite.isObject( new Number( 3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-infinite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-infinite/docs/types/index.d.ts index 2829486b255..b69a6541b77 100644 --- a/lib/node_modules/@stdlib/assert/is-infinite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-infinite/docs/types/index.d.ts @@ -44,7 +44,7 @@ interface IsInfinite { * var bool = isInfinite( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having an infinite value. @@ -60,7 +60,7 @@ interface IsInfinite { * var bool = isInfinite.isPrimitive( new Number( -1.0/0.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having an infinite value. @@ -76,7 +76,7 @@ interface IsInfinite { * var bool = isInfinite.isObject( new Number( 1.0/0.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-integer/docs/types/index.d.ts index 639ca0c99a0..44836dc7467 100644 --- a/lib/node_modules/@stdlib/assert/is-integer/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-integer/docs/types/index.d.ts @@ -44,7 +44,7 @@ interface IsInteger { * var bool = isInteger( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having an integer value. @@ -60,7 +60,7 @@ interface IsInteger { * var bool = isInteger.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having an integer value. @@ -76,7 +76,7 @@ interface IsInteger { * var bool = isInteger.isObject( new Number( 3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nan/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nan/docs/types/index.d.ts index 145de9bab95..cb5769b5991 100644 --- a/lib/node_modules/@stdlib/assert/is-nan/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nan/docs/types/index.d.ts @@ -44,7 +44,7 @@ interface IsNaN { * var bool = isnan( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a `NaN` number primitive. @@ -64,7 +64,7 @@ interface IsNaN { * var bool = isnan.isPrimitive( new Number( NaN ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value of `NaN`. @@ -80,7 +80,7 @@ interface IsNaN { * var bool = isnan.isObject( new Number( NaN ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-negative-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-negative-finite/docs/types/index.d.ts index 2bc21dd57ef..b4f98e92171 100644 --- a/lib/node_modules/@stdlib/assert/is-negative-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-negative-finite/docs/types/index.d.ts @@ -52,7 +52,7 @@ interface isNegativeFinite { * var bool = isNegativeFinite( -1.0/0.0 ); * // returns false */ - ( value: number | Number ): value is number | Number; + ( value: number | Number ): boolean; /** * Tests if a value is a number primitive having a finite negative value. @@ -68,7 +68,7 @@ interface isNegativeFinite { * var bool = isNegativeFinite.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: number | Number ): value is number; + isPrimitive( value: number | Number ): boolean; /** * Tests if a value is a number object having a negative value. @@ -84,7 +84,7 @@ interface isNegativeFinite { * var bool = isNegativeFinite.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: number | Number ): value is Number; + isObject( value: number | Number ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-negative-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-negative-integer/docs/types/index.d.ts index f17d7ed6fcb..8867c96e044 100644 --- a/lib/node_modules/@stdlib/assert/is-negative-integer/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-negative-integer/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNegativeInteger { * var bool = isNegativeInteger( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a negative integer value. @@ -64,7 +64,7 @@ interface IsNegativeInteger { * var bool = isNegativeInteger.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a negative integer value. @@ -80,7 +80,7 @@ interface IsNegativeInteger { * var bool = isNegativeInteger.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-negative-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-negative-number/docs/types/index.d.ts index 87f186bb2eb..f8ed0c3444b 100644 --- a/lib/node_modules/@stdlib/assert/is-negative-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-negative-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNegativeNumber { * var bool = isNegativeNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a negative value. @@ -64,7 +64,7 @@ interface IsNegativeNumber { * var bool = isNegativeNumber.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a negative value. @@ -80,7 +80,7 @@ interface IsNegativeNumber { * var bool = isNegativeNumber.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-negative-zero/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-negative-zero/docs/types/index.d.ts index bcf13856416..3d13d14e866 100644 --- a/lib/node_modules/@stdlib/assert/is-negative-zero/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-negative-zero/docs/types/index.d.ts @@ -52,7 +52,7 @@ interface IsNegativeZero { * var bool = isNegativeZero( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive equal to negative zero. @@ -68,7 +68,7 @@ interface IsNegativeZero { * var bool = isNegativeZero.isPrimitive( new Number( -0.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value equal to negative zero. @@ -84,7 +84,7 @@ interface IsNegativeZero { * var bool = isNegativeZero.isObject( new Number( -0.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts index 45d251165e7..2ccf2cf1ebf 100644 --- a/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts @@ -52,7 +52,7 @@ interface IsNonNegativeFinite { * var bool = isNonNegativeFinite( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonnegative finite value. @@ -76,7 +76,7 @@ interface IsNonNegativeFinite { * var bool = isNonNegativeFinite( 1.0/0.0 ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a finite number object having a nonnegative value. @@ -100,7 +100,7 @@ interface IsNonNegativeFinite { * var bool = isNonNegativeFinite( 1.0/0.0 ); * // returns false */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonnegative-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonnegative-integer/docs/types/index.d.ts index 9110ad7bca1..9730b299cc6 100644 --- a/lib/node_modules/@stdlib/assert/is-nonnegative-integer/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonnegative-integer/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNonNegativeInteger { * var bool = isNonNegativeInteger( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonnegative integer value. @@ -64,7 +64,7 @@ interface IsNonNegativeInteger { * var bool = isNonNegativeInteger.isPrimitive( new Number( 3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a nonnegative integer value. @@ -80,7 +80,7 @@ interface IsNonNegativeInteger { * var bool = isNonNegativeInteger.isObject( new Number( 3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonnegative-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonnegative-number/docs/types/index.d.ts index 9222ef621f7..ca33ac394f0 100644 --- a/lib/node_modules/@stdlib/assert/is-nonnegative-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonnegative-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNonNegativeNumber { * var bool = isNonNegativeNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonnegative value. @@ -64,7 +64,7 @@ interface IsNonNegativeNumber { * var bool = isNonNegativeNumber.isPrimitive( new Number( 3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a nonnegative value. @@ -80,7 +80,7 @@ interface IsNonNegativeNumber { * var bool = isNonNegativeNumber.isObject( new Number( 3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts index 61c2aa00d5b..b7532e99be8 100644 --- a/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonpositive-finite/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNonPositiveFinite { * var bool = isNonPositiveFinite( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonpositive finite value. @@ -64,7 +64,7 @@ interface IsNonPositiveFinite { * var bool = isNonPositiveFinite.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a nonpositive finite value. @@ -80,7 +80,7 @@ interface IsNonPositiveFinite { * var bool = isNonPositiveFinite.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonpositive-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonpositive-integer/docs/types/index.d.ts index 4197c4f2d4d..bfc8781d4d9 100644 --- a/lib/node_modules/@stdlib/assert/is-nonpositive-integer/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonpositive-integer/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNonPositiveInteger { * var bool = isNonPositiveInteger( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonpositive integer value. @@ -64,7 +64,7 @@ interface IsNonPositiveInteger { * var bool = isNonPositiveInteger.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a nonpositive integer value. @@ -80,7 +80,7 @@ interface IsNonPositiveInteger { * var bool = isNonPositiveInteger.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-nonpositive-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-nonpositive-number/docs/types/index.d.ts index e61f0ea1f54..99beaac971a 100644 --- a/lib/node_modules/@stdlib/assert/is-nonpositive-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-nonpositive-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsNonPositiveNumber { * var bool = isNonPositiveNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a nonpositive value. @@ -64,7 +64,7 @@ interface IsNonPositiveNumber { * var bool = isNonPositiveNumber.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a nonpositive value. @@ -80,7 +80,7 @@ interface IsNonPositiveNumber { * var bool = isNonPositiveNumber.isObject( new Number( -3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-odd/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-odd/docs/types/index.d.ts index 198a4b174c1..0245bd0cdfa 100644 --- a/lib/node_modules/@stdlib/assert/is-odd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-odd/docs/types/index.d.ts @@ -52,7 +52,7 @@ interface IsOdd { * var bool = isOdd( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive that is an odd number. @@ -68,7 +68,7 @@ interface IsOdd { * var bool = isOdd.isPrimitive( new Number( -5.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object that is an odd number. @@ -84,7 +84,7 @@ interface IsOdd { * var bool = isOdd.isObject( new Number( 5.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** 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 index df844292063..c91f096f133 100644 --- 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 ): value is number | Number; + ( value: any ): boolean; /** * 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 ): value is number; + isPrimitive( value: any ): boolean; /** * 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 ): value is Number; + isObject( value: any ): boolean; } /** 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 index 2b4e80261ab..428104123ae 100644 --- 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 ): value is number | Number; + ( value: any ): boolean; /** * 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 ): value is number; + isPrimitive( value: any ): boolean; /** * 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 ): value is Number; + isObject( value: any ): boolean; } /** 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 index bbff877b835..731c78196c3 100644 --- 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 ): value is number | Number; + ( value: any ): boolean; /** * 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 ): value is number; + isPrimitive( value: any ): boolean; /** * 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 ): value is Number; + isObject( value: any ): boolean; } /** 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 index 3797c0b9652..6b5e8928f82 100644 --- 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 ): value is number | Number; + ( value: any ): boolean; /** * 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 ): value is number; + isPrimitive( value: any ): boolean; /** * 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 ): value is Number; + isObject( value: any ): boolean; } /** 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 index b84f8c5a750..c94f7c1a69d 100644 --- 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 ): value is number | Number; + ( value: any ): boolean; /** * 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 ): value is number; + isPrimitive( value: any ): boolean; /** * 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 ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-safe-integer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-safe-integer/docs/types/index.d.ts index 7bf87d9b300..55962e832b1 100644 --- a/lib/node_modules/@stdlib/assert/is-safe-integer/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-safe-integer/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsSafeInteger { * var bool = isSafeInteger( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a safe integer value. @@ -64,7 +64,7 @@ interface IsSafeInteger { * var bool = isSafeInteger.isPrimitive( new Number( -3.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** @@ -81,7 +81,7 @@ interface IsSafeInteger { * var bool = isSafeInteger.isObject( new Number( 3.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/types/index.d.ts index dd4ecd2990c..e12fffdef1c 100644 --- a/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsSquareTriangularNumber { * var bool = isSquareTriangularNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a value which is a square triangular number. @@ -64,7 +64,7 @@ interface IsSquareTriangularNumber { * var bool = isSquareTriangularNumber.isPrimitive( new Number( 36.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value which is a square triangular number. @@ -80,7 +80,7 @@ interface IsSquareTriangularNumber { * var bool = isSquareTriangularNumber.isObject( new Number( 36.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-triangular-number/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-triangular-number/docs/types/index.d.ts index 36b2e05f91e..06ca5faf02c 100644 --- a/lib/node_modules/@stdlib/assert/is-triangular-number/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-triangular-number/docs/types/index.d.ts @@ -48,7 +48,7 @@ interface IsTriangularNumber { * var bool = isTriangularNumber( null ); * // returns false */ - ( value: any ): value is number | Number; + ( value: any ): boolean; /** * Tests if a value is a number primitive having a value which is a triangular number. @@ -64,7 +64,7 @@ interface IsTriangularNumber { * var bool = isTriangularNumber.isPrimitive( new Number( 36.0 ) ); * // returns false */ - isPrimitive( value: any ): value is number; + isPrimitive( value: any ): boolean; /** * Tests if a value is a number object having a value which is a triangular number. @@ -80,7 +80,7 @@ interface IsTriangularNumber { * var bool = isTriangularNumber.isObject( new Number( 36.0 ) ); * // returns true */ - isObject( value: any ): value is Number; + isObject( value: any ): boolean; } /** diff --git a/lib/node_modules/@stdlib/assert/is-typed-array-length/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-typed-array-length/docs/types/index.d.ts index d13a2ce9e58..b6df04bb750 100644 --- a/lib/node_modules/@stdlib/assert/is-typed-array-length/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/assert/is-typed-array-length/docs/types/index.d.ts @@ -36,7 +36,7 @@ * var bool = isTypedArrayLength( 3.14 ); * // returns false */ -declare function isTypedArrayLength( value: any ): value is number; +declare function isTypedArrayLength( value: any ): boolean; // EXPORTS //