feat: use type predicates for narrowing

stdlib-js · Jun 28, 2023 · e2c4238 · e2c4238
1 parent f3f86f0
commit e2c4238
Show file tree

Hide file tree

Showing 11 changed files with 11 additions and 11 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-uint16array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-uint16array/docs/types/index.d.ts
@@ -32,7 +32,7 @@
 * var bool = isUint16Array( [] );
 * // returns false
 */
-declare function isUint16Array( value: any ): boolean;
+declare function isUint16Array( value: any ): value is Uint16Array;
 
 
 // EXPORTS //

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

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

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

diff --git a/lib/node_modules/@stdlib/assert/is-unc-path/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-unc-path/docs/types/index.d.ts
@@ -32,7 +32,7 @@
 * var bool = isUNCPath( '/foo/bar/baz' );
 * // returns false
 */
-declare function isUNCPath( value: any ): boolean;
+declare function isUNCPath( value: any ): value is string;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-undefined-or-null/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * bool = isUndefinedOrNull( false );
 * // returns false
 */
-declare function isUndefinedOrNull( value: any ): boolean;
+declare function isUndefinedOrNull( value: any ): value is null | undefined;
 
 
 // EXPORTS //

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

diff --git a/lib/node_modules/@stdlib/assert/is-unity-probability-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-unity-probability-array/docs/types/index.d.ts
@@ -40,7 +40,7 @@
 * var bool = isUnityProbabilityArray( [ 3.14, 0.0 ] );
 * // returns false
 */
-declare function isUnityProbabilityArray( v: any ): boolean;
+declare function isUnityProbabilityArray( v: any ): v is ArrayLike<number>;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-uppercase/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-uppercase/docs/types/index.d.ts
@@ -40,7 +40,7 @@
 * var bool = isUppercase( 'salt and light' );
 * // returns false
 */
-declare function isUppercase( value: any ): boolean;
+declare function isUppercase( value: any ): value is string;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-uri-error/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-uri-error/docs/types/index.d.ts
@@ -36,7 +36,7 @@
 * var bool = isURIError( {} );
 * // returns false
 */
-declare function isURIError( value: any ): boolean;
+declare function isURIError( value: any ): value is URIError;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/assert/is-uri/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-uri/docs/types/index.d.ts
@@ -119,7 +119,7 @@
 * var bool = isURI( 'http://example.w3.org/%at' );
 * // returns false
 */
-declare function isURI( value: any ): boolean;
+declare function isURI( value: any ): value is string;
 
 
 // EXPORTS //