Skip to content

feat!: improve type declarations for utils/map-arguments #2050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2024
Merged

feat!: improve type declarations for utils/map-arguments #2050

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b2dd25
refactor: improve type definitions for map arguments func
prajwalkulkarni Mar 26, 2024
ce44167
feat: improve type safety
Planeshifter Oct 14, 2024
c931dec
chore: revert changes
Planeshifter Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion lib/node_modules/@stdlib/utils/map-arguments/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,57 @@
* var out = bar( 1, 2, 3 );
* // returns [ 2, 4, 6 ]
*/
declare function mapArguments( fcn: Function, clbk: Function, thisArg?: any ): Function;
declare function mapArguments<
T extends ( ...args: Array<any> ) => any,
C extends ( this: ThisParameterType<T>, value: Parameters<T>[number], index: number ) => any
>(
fcn: T,
clbk: C
): ( ...args: Parameters<T> ) => ReturnType<T>;

/**
* Returns a function that applies arguments to a provided function after transforming arguments according to a callback function.
*
* ## Notes
*
* - The callback function is provided the following arguments:
*
* - **value**: argument value.
* - **index**: argument index.
*
* @param fcn - input function
* @param clbk - callback function
* @param thisArg - input function context
* @returns function wrapper
*
* @example
* function foo( a, b, c ) {
* return [ a, b, c ];
* }
*
* function clbk( v ) {
* this.count += 1;
* return v * 2;
* }
*
* var thisArg = { 'count': 0 };
* var bar = mapArguments( foo, clbk, thisArg );
*
* var out = bar( 1, 2, 3 );
* // returns [ 2, 4, 6 ]
*
* var count = thisArg.count;
* // returns 3
*/
declare function mapArguments<
T extends ( ...args: Array<any> ) => any,
C extends ( this: ThisParameterType<T>, value: Parameters<T>[number], index: number ) => any,
ThisArg
>(
fcn: T,
clbk: C,
thisArg: ThisArg
): ( this: ThisArg, ...args: Parameters<T> ) => ReturnType<T>;


// EXPORTS //
Expand Down
64 changes: 39 additions & 25 deletions lib/node_modules/@stdlib/utils/map-arguments/docs/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,37 @@

import mapArguments = require( './index' );

/**
* Callback function.
*
* @param v - argument
* @returns result
*/
function clbk( v: any ): any {
// FUNCTIONS //

function clbk<T>( v: T ): T {
return v;
}

function stringify( n: number ): string {
return n.toString();
}

function sum( ...numbers: Array<number> ): number {
return numbers.reduce( ( a, b ) => a + b, 0 );
}

function greet( this: { name: string }, greeting: string ): string {
return `${greeting}, ${this.name}!`; // eslint-disable-line no-invalid-this
}


// TESTS //

// The function returns a function...
{
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], clbk ); // $ExpectType Function
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], clbk, {} ); // $ExpectType Function
mapArguments( ( x: number, y: number, z: number ): Array<number> => [ x, y, z ], clbk ); // $ExpectType (x: number, y: number, z: number) => number[]
mapArguments( ( x: string, y: string, z: string ): Array<string> => [ x, y, z ], clbk, {} ); // $ExpectType (this: {}, x: string, y: string, z: string) => string[]
mapArguments( ( x: number, y: number ): number => x + y, clbk ); // $ExpectType (x: number, y: number) => number

mapArguments( stringify, ( x: number ) => x * 2 ); // $ExpectType (n: number) => string
mapArguments( sum, ( x: number ) => x * 2 ); // $ExpectType (...args: number[]) => number

mapArguments( greet, ( s: string ) => s.toUpperCase(), { 'name': 'World' } ); // $ExpectType (this: { name: string; }, greeting: string) => string
}

// The compiler throws an error if the function is provided a first argument other than a function...
Expand All @@ -56,24 +70,24 @@ function clbk( v: any ): any {

// The compiler throws an error if the function is provided a second argument other than a function...
{
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], '5' ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], true ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], false ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], 123 ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], null ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], [] ); // $ExpectError

mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], '5', {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], true, {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], false, {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], 123, {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], null, {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], {}, {} ); // $ExpectError
mapArguments( ( x: any, y: any, z: any ): Array<any> => [ x, y, z ], [], {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], '5' ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], true ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], false ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], 123 ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], null ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], [] ); // $ExpectError

mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], '5', {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], true, {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], false, {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], 123, {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], null, {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], {}, {} ); // $ExpectError
mapArguments( ( x, y, z ): Array<string> => [ x, y, z ], [], {} ); // $ExpectError
}

// The compiler throws an error if the function is provided more than three arguments...
{
mapArguments( ( x: number, y: number ): number => x + y, clbk, {}, 4 ); // $ExpectError
mapArguments( ( x, y ): number => x + y, clbk, {}, 4 ); // $ExpectError
}
Loading