feat!: refactor declarations to preserve type info

kgryte · kgryte · commit 0e16a7bae331 · 2023-06-27T16:23:05.000-07:00
diff --git a/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts
@@ -21,7 +21,7 @@
 /// <reference types="@stdlib/types"/>
 
 import * as random from '@stdlib/types/random';
-import { Iterator } from '@stdlib/types/iter';
+import { TypedIterator } from '@stdlib/types/iter';
 
 /**
 * Interface defining function options.
@@ -61,7 +61,7 @@ interface Options {
 /**
 * Interface for iterators of pseudorandom numbers having integer values.
 */
-interface RandIter extends Iterator {
+interface Iterator<T> extends TypedIterator<T> {
 	/**
 	* Underlying pseudorandom number generator.
 	*/
@@ -120,7 +120,7 @@ interface RandIter extends Iterator {
 *
 * // ...
 */
-declare function iterator( options?: Options ): RandIter;
+declare function iterator( options?: Options ): Iterator<number>;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/random/iter/randn/docs/types/test.ts b/lib/node_modules/@stdlib/random/iter/randn/docs/types/test.ts
@@ -23,10 +23,10 @@ import iterator = require( './index' );
 
 // The function returns an iterator...
 {
-	iterator(); // $ExpectType RandIter
-	iterator( { 'iter': 10 } ); // $ExpectType RandIter
-	iterator( { 'name': 'box-muller' } ); // $ExpectType RandIter
-	iterator( { 'copy': false } ); // $ExpectType RandIter
+	iterator(); // $ExpectType Iterator<number>
+	iterator( { 'iter': 10 } ); // $ExpectType Iterator<number>
+	iterator( { 'name': 'box-muller' } ); // $ExpectType Iterator<number>
+	iterator( { 'copy': false } ); // $ExpectType Iterator<number>
 }
 
 // The compiler throws an error if the function is provided an options argument which is not an object...

Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,10 @@ import iterator = require( './index' );`
`23`	`23`
`24`	`24`	`// The function returns an iterator...`
`25`	`25`	`{`
`26`		`- iterator(); // $ExpectType RandIter`
`27`		`- iterator( { 'iter': 10 } ); // $ExpectType RandIter`
`28`		`- iterator( { 'name': 'box-muller' } ); // $ExpectType RandIter`
`29`		`- iterator( { 'copy': false } ); // $ExpectType RandIter`
	`26`	`+ iterator(); // $ExpectType Iterator<number>`
	`27`	`+ iterator( { 'iter': 10 } ); // $ExpectType Iterator<number>`
	`28`	`+ iterator( { 'name': 'box-muller' } ); // $ExpectType Iterator<number>`
	`29`	`+ iterator( { 'copy': false } ); // $ExpectType Iterator<number>`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`// The compiler throws an error if the function is provided an options argument which is not an object...`