Skip to content

fix: use the correct TypeScript callback signature and update docs for array/base/for-each #5448

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 1 commit into from
Feb 25, 2025
Merged

fix: use the correct TypeScript callback signature and update docs for array/base/for-each #5448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/for-each/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
Callback function.

thisArg: any (optional)
Callback function execution context.
Callback execution context.

Examples
--------
Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/array/base/for-each/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type Unary<T, V> = ( this: V, value: T ) => void;
* @param value - current array element
* @param index - current array element index
*/
type Binary<T, V> = ( this: V, value: T, indices: Array<number> ) => void;
type Binary<T, V> = ( this: V, value: T, index: number ) => void;

/**
* Callback invoked for each array element.
Expand All @@ -49,7 +49,7 @@ type Binary<T, V> = ( this: V, value: T, indices: Array<number> ) => void;
* @param index - current array element index
* @param arr - input array
*/
type Ternary<T, U, V> = ( this: V, value: T, indices: Array<number>, arr: U ) => void;
type Ternary<T, U, V> = ( this: V, value: T, index: number, arr: U ) => void;

/**
* Callback invoked for each array element.
Expand All @@ -65,7 +65,7 @@ type Callback<T, U, V> = Nullary<V> | Unary<T, V> | Binary<T, V> | Ternary<T, U,
*
* @param x - input array
* @param fcn - callback function
* @param thisArg - callback function execution context
* @param thisArg - callback execution context
*
* @example
* var naryFunction = require( '@stdlib/utils/nary-function' );
Expand All @@ -84,7 +84,7 @@ declare function forEach<T = unknown, V = unknown>( x: AccessorArrayLike<T>, fcn
*
* @param x - input array
* @param fcn - callback function
* @param thisArg - callback function execution context
* @param thisArg - callback execution context
*
* @example
* var naryFunction = require( '@stdlib/utils/nary-function' );
Expand Down