Auto-generated commit

Author: stdlib-bot

base/flag/docs/types/index.d.ts

@@ -20,12 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ndarray } from '@stdlib/types/ndarray';
-
-/**
-* Flag name.
-*/
-type Flag = string | symbol | number;
+import { ndarray, Flags } from '@stdlib/types/ndarray';
 
 /**
 * Returns a specified flag for a provided ndarray.
@@ -40,7 +35,7 @@ type Flag = string | symbol | number;
 * var o = flag( zeros( [ 3, 3, 3 ] ), 'READONLY' );
 * // returns <boolean>
 */
-declare function flag<T = unknown>( x: ndarray, name: Flag ): T;
+declare function flag<V extends keyof Flags>( x: ndarray, name: V ): Flags[V];
 
 
 // EXPORTS //

base/flag/docs/types/test.ts

@@ -24,7 +24,7 @@ import flag = require( './index' );
 
 // The function returns an ndarray flag...
 {
-	flag<boolean>( zeros( [ 3, 2, 1 ] ), 'READONLY' ); // $ExpectType boolean
+	flag( zeros( [ 3, 2, 1 ] ), 'READONLY' ); // $ExpectType boolean | undefined
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an ndarray...

base/flags/docs/types/index.d.ts

@@ -20,27 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ndarray } from '@stdlib/types/ndarray';
-
-/**
-* Flags and other meta information (e.g., memory layout of the array).
-*/
-interface Flags {
-	/**
-	* Boolean indicating if an array is row-major contiguous.
-	*/
-	ROW_MAJOR_CONTIGUOUS?: boolean;
-
-	/**
-	* Boolean indicating if an array is column-major contiguous.
-	*/
-	COLUMN_MAJOR_CONTIGUOUS?: boolean;
-
-	/**
-	* Boolean indicating if an array is read-only.
-	*/
-	READONLY?: boolean;
-}
+import { ndarray, Flags } from '@stdlib/types/ndarray';
 
 /**
 * Returns the flags of a provided ndarray.
@@ -59,7 +39,7 @@ interface Flags {
 * var o = flags( zeros( [ 3, 3, 3 ] ), false );
 * // returns {...}
 */
-declare function flags( x: ndarray, copy: boolean ): Flags;
+declare function flags<T = unknown>( x: ndarray, copy: boolean ): Flags<T>;
 
 
 // EXPORTS //