feat: use type predicates for narrowing

Planeshifter · Planeshifter · commit 3c153c4341c5 · 2023-06-27T21:03:35.000-04:00
diff --git a/lib/node_modules/@stdlib/assert/is-absolute-http-uri/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-absolute-http-uri/docs/types/index.d.ts
@@ -48,7 +48,7 @@
 * var bool = isAbsoluteHttpURI( null );
 * // returns false
 */
-declare function isAbsoluteHttpURI( value: any ): boolean;
+declare function isAbsoluteHttpURI( value: any ): value is string;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-absolute-path/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-absolute-path/docs/types/index.d.ts
@@ -39,7 +39,7 @@ interface IsAbsolutePath {
 	*     // returns true
 	* }
 	*/
-	( value: any ): boolean;
+	( value: any ): value is string;
 
 	/**
 	* Tests if a value is a POSIX absolute path.
@@ -55,7 +55,7 @@ interface IsAbsolutePath {
 	* var bool = isAbsolutePath.posix( 'foo/bar/baz' );
 	* // returns false
 	*/
-	posix( value: any ): boolean;
+	posix( value: any ): value is string;
 
 	/**
 	* Tests if a value is a Windows absolute path.
@@ -71,7 +71,7 @@ interface IsAbsolutePath {
 	* var bool = isAbsolutePath.win32( 'foo\\bar\\baz' );
 	* // returns false
 	*/
-	win32( value: any ): boolean;
+	win32( value: any ): value is string;
 }
 
 /**
diff --git a/lib/node_modules/@stdlib/assert/is-absolute-uri/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-absolute-uri/docs/types/index.d.ts
@@ -44,7 +44,7 @@
 * var bool = isAbsoluteURI( null );
 * // returns false
 */
-declare function isAbsoluteURI( value: any ): boolean;
+declare function isAbsoluteURI( value: any ): value is string;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-accessor-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-accessor-array/docs/types/index.d.ts
@@ -39,7 +39,7 @@
 * var bool = isAccessorArray( {} );
 * // returns false
 */
-declare function isAccessorArray( value: any ): boolean;
+declare function isAccessorArray( value: any ): value is ArrayLike<any>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-alphagram/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-alphagram/docs/types/index.d.ts
@@ -48,7 +48,7 @@
 * var out = isAlphagram( 123 );
 * // returns false
 */
-declare function isAlphagram( value: any ): boolean;
+declare function isAlphagram( value: any ): value is string;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-alphanumeric/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-alphanumeric/docs/types/index.d.ts
@@ -44,7 +44,7 @@
 * var out = isAlphaNumeric( 123 );
 * // returns false
 */
-declare function isAlphaNumeric( value: any ): boolean;
+declare function isAlphaNumeric( value: any ): value is string;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-arguments/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arguments/docs/types/index.d.ts
@@ -36,7 +36,7 @@
 * var bool = isArguments( [] );
 * // returns false
 */
-declare function isArguments( value: any ): boolean;
+declare function isArguments( value: any ): value is IArguments;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-array-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-array/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * bool = isArrayArray( [] );
 * // returns false
 */
-declare function isArrayArray( value: any ): boolean;
+declare function isArrayArray( value: any ): value is Array<Array<any>>;
 
 
 // EXPORTS //
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
@@ -36,7 +36,7 @@
 * var bool = isArrayLength( 3.14 );
 * // returns false
 */
-declare function isArrayLength( value: any ): boolean;
+declare function isArrayLength( value: any ): value is number;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-array-like-object/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-like-object/docs/types/index.d.ts
@@ -40,9 +40,9 @@
 * var bool = isArrayLikeObject( 'beep' );
 * // returns false
 */
-declare function isArrayLike( value: any ): boolean;
+declare function isArrayLikeObject( value: any ): value is ArrayLike<any>;
 
 
 // EXPORTS //
 
-export = isArrayLike;
+export = isArrayLikeObject;
diff --git a/lib/node_modules/@stdlib/assert/is-array-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array-like/docs/types/index.d.ts
@@ -36,7 +36,7 @@
 * var bool = isArrayLike( {'length':10} );
 * // returns true
 */
-declare function isArrayLike( value: any ): boolean;
+declare function isArrayLike( value: any ): value is ArrayLike<any>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-array/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-array/docs/types/index.d.ts
@@ -32,7 +32,7 @@
 * var bool = isArray( {} );
 * // returns false
 */
-declare function isArray( value: any ): boolean;
+declare function isArray( value: any ): value is Array<any>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-arraybuffer-view/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arraybuffer-view/docs/types/index.d.ts
@@ -33,7 +33,7 @@
 * var bool = isArrayBufferView( [] );
 * // returns false
 */
-declare function isArrayBufferView( value: any ): boolean;
+declare function isArrayBufferView( value: any ): value is ArrayBufferView;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arraybuffer/docs/types/index.d.ts
@@ -34,7 +34,7 @@
 * var bool = isArrayBuffer( [] );
 * // returns false
 */
-declare function isArrayBuffer( value: any ): boolean;
+declare function isArrayBuffer( value: any ): value is ArrayBuffer;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-arrow-function/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-arrow-function/docs/types/index.d.ts
@@ -37,7 +37,7 @@
 * var bool = isArrowFunction( beep );
 * // returns false
 */
-declare function isArrowFunction( value: any ): boolean;
+declare function isArrowFunction( value: any ): value is ( () => any );
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/assert/is-ascii/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-ascii/docs/types/index.d.ts
@@ -40,7 +40,7 @@
 * var out = isASCII( 123 );
 * // returns false
 */
-declare function isASCII( value: any ): boolean;
+declare function isASCII( value: any ): value is string;
 
 
 // EXPORTS //
