feat!: fix parameter order and ensure type safety of this context

Planeshifter · Planeshifter · commit d97df70e5296 · 2023-07-19T11:03:13.000-04:00
diff --git a/lib/node_modules/@stdlib/utils/while/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/while/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Checks whether an iteration number passes a test.
@@ -51,7 +51,7 @@ type Predicate = ( i: number ) => boolean;
 *
 * whilst( predicate, beep );
 */
-declare function whilst( fcn: Function, predicate: Predicate, thisArg?: any ): void; // tslint:disable-line: max-line-length
+declare function whilst<T extends Function>( predicate: Predicate, fcn: T, thisArg?: ThisParameterType<T> ): void; // tslint:disable-line: max-line-length
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/utils/while/docs/types/test.ts b/lib/node_modules/@stdlib/utils/while/docs/types/test.ts
@@ -40,32 +40,32 @@ function noop() {
 
 // The function does not return a value...
 {
-	whilst( noop, predicate ); // $ExpectType void
-	whilst( noop, predicate, {} ); // $ExpectType void
+	whilst( predicate, noop ); // $ExpectType void
+	whilst( predicate, noop, {} ); // $ExpectType void
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a function...
 {
-	whilst( 'abc', predicate ); // $ExpectError
-	whilst( 5, predicate ); // $ExpectError
-	whilst( true, predicate ); // $ExpectError
-	whilst( false, predicate ); // $ExpectError
-	whilst( [], predicate ); // $ExpectError
-	whilst( {}, predicate ); // $ExpectError
+	whilst( 'abc', noop ); // $ExpectError
+	whilst( 5, noop ); // $ExpectError
+	whilst( true, noop ); // $ExpectError
+	whilst( false, noop ); // $ExpectError
+	whilst( [], noop ); // $ExpectError
+	whilst( {}, noop ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a second argument which is not a function...
 {
-	whilst( noop, 'abc' ); // $ExpectError
-	whilst( noop, 5 ); // $ExpectError
-	whilst( noop, true ); // $ExpectError
-	whilst( noop, false ); // $ExpectError
-	whilst( noop, [] ); // $ExpectError
-	whilst( noop, {} ); // $ExpectError
+	whilst( predicate, 'abc' ); // $ExpectError
+	whilst( predicate, 5 ); // $ExpectError
+	whilst( predicate, true ); // $ExpectError
+	whilst( predicate, false ); // $ExpectError
+	whilst( predicate, [] ); // $ExpectError
+	whilst( predicate, {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided fewer than two arguments...
 {
 	whilst(); // $ExpectError
-	whilst( noop ); // $ExpectError
+	whilst( predicate ); // $ExpectError
 }

Original file line number	Diff line number	Diff line change
`@@ -40,32 +40,32 @@ function noop() {`
`40`	`40`
`41`	`41`	`// The function does not return a value...`
`42`	`42`	`{`
`43`		`- whilst( noop, predicate ); // $ExpectType void`
`44`		`- whilst( noop, predicate, {} ); // $ExpectType void`
	`43`	`+ whilst( predicate, noop ); // $ExpectType void`
	`44`	`+ whilst( predicate, noop, {} ); // $ExpectType void`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`// The compiler throws an error if the function is provided a first argument which is not a function...`
`48`	`48`	`{`
`49`		`- whilst( 'abc', predicate ); // $ExpectError`
`50`		`- whilst( 5, predicate ); // $ExpectError`
`51`		`- whilst( true, predicate ); // $ExpectError`
`52`		`- whilst( false, predicate ); // $ExpectError`
`53`		`- whilst( [], predicate ); // $ExpectError`
`54`		`- whilst( {}, predicate ); // $ExpectError`
	`49`	`+ whilst( 'abc', noop ); // $ExpectError`
	`50`	`+ whilst( 5, noop ); // $ExpectError`
	`51`	`+ whilst( true, noop ); // $ExpectError`
	`52`	`+ whilst( false, noop ); // $ExpectError`
	`53`	`+ whilst( [], noop ); // $ExpectError`
	`54`	`+ whilst( {}, noop ); // $ExpectError`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`// The compiler throws an error if the function is provided a second argument which is not a function...`
`58`	`58`	`{`
`59`		`- whilst( noop, 'abc' ); // $ExpectError`
`60`		`- whilst( noop, 5 ); // $ExpectError`
`61`		`- whilst( noop, true ); // $ExpectError`
`62`		`- whilst( noop, false ); // $ExpectError`
`63`		`- whilst( noop, [] ); // $ExpectError`
`64`		`- whilst( noop, {} ); // $ExpectError`
	`59`	`+ whilst( predicate, 'abc' ); // $ExpectError`
	`60`	`+ whilst( predicate, 5 ); // $ExpectError`
	`61`	`+ whilst( predicate, true ); // $ExpectError`
	`62`	`+ whilst( predicate, false ); // $ExpectError`
	`63`	`+ whilst( predicate, [] ); // $ExpectError`
	`64`	`+ whilst( predicate, {} ); // $ExpectError`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`// The compiler throws an error if the function is provided fewer than two arguments...`
`68`	`68`	`{`
`69`	`69`	`whilst(); // $ExpectError`
`70`		`- whilst( noop ); // $ExpectError`
	`70`	`+ whilst( predicate ); // $ExpectError`
`71`	`71`	`}`