Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Sep 28, 2024
1 parent 23ab234 commit d00482b
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ A total of 3 people contributed to this release. Thank you to the following cont

<details>

- [`abf0407`](https://github.com/stdlib-js/stdlib/commit/abf040787f6598438b0100a729a8331b7f80f62f) - **chore:** resolve lint errors in TS files _(by Philipp Burckhardt)_
- [`b89c97c`](https://github.com/stdlib-js/stdlib/commit/b89c97ce0b812ff0b2aab16b4d77969d44fe3e8c) - **docs:** resolve lint errors in TS declaration files _(by Philipp Burckhardt)_
- [`a59219e`](https://github.com/stdlib-js/stdlib/commit/a59219e11d1951ec26cb44a4972e7616e4d8087f) - **fix:** update import path for collection type _(by Philipp Burckhardt)_
- [`7f368f6`](https://github.com/stdlib-js/stdlib/commit/7f368f6c3f4cea444a304a62616cea36a5f143eb) - **fix:** remove unused imports from TS declaration file _(by Philipp Burckhardt)_
Expand Down
2 changes: 1 addition & 1 deletion async/compose/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ type BinaryFunction = ( result: any, next: DoneCallback ) => void;
*
* ## Notes
*
* - Only the rightmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as binary functions.
* - Only the rightmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as binary functions.
*
* @param args - arguments
* @param next - invoked upon function completion
Expand Down
2 changes: 1 addition & 1 deletion async/every-by-right/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const isPositive = ( v: number ): boolean => {
return ( v > 0 );
};

const done = ( error: Error | null, bool: boolean ) => {
const done = ( error: Error | null, bool: boolean ): void => {
if ( error ) {
throw error;
}
Expand Down
2 changes: 1 addition & 1 deletion entries/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import objectEntries = require( './index' );

// The function returns an array of key-value pairs...
{
objectEntries( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType [string, any][]
objectEntries( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType KeyValuePair[]
}

// The compiler throws an error if the function is provided an incorrect number of arguments...
Expand Down
6 changes: 3 additions & 3 deletions every-in-by/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
/**
* Checks whether all own and inherited properties in an object pass a test implemented by a predicate function.
*
* @param obj - The object to iterate over
* @param predicate - The test function to apply to each property
* @param thisArg - Optional execution context for the predicate function
* @param obj - object to iterate over
* @param predicate - test function to apply to each property
* @param thisArg - optional execution context for the predicate function
* @throws if `obj` is not an object or if `predicate` is not a function
* @returns boolean indicating whether all properties pass the test
*/
Expand Down
4 changes: 2 additions & 2 deletions group/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ import group = require( './index' );

// The function returns an object...
{
group( [ 'beep', 'boop', 'foo', 'bar' ], [ 'b', 'b', 'f', 'b' ] ); // $ExpectType any
group( [ 'beep', 'boop', 'foo', 'bar' ], [ 'b', 'b', 'f', 'b' ] ); // $ExpectType { b: Collection<string>; f: Collection<string>; }
const opts = {
'returns': 'indices' as 'indices'
};
group( [ 'beep', 'boop', 'foo', 'bar' ], opts, [ 'b', 'b', 'f', 'b' ] ); // $ExpectType any
group( [ 'beep', 'boop', 'foo', 'bar' ], opts, [ 'b', 'b', 'f', 'b' ] ); // $ExpectType { b: Collection<string>; f: Collection<string>; }
}

// The compiler throws an error if the function is provided a first argument which is not a collection...
Expand Down
2 changes: 1 addition & 1 deletion key-by/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ function toKey( value: Foo ): string {
*/
const funcs = {
'count': 0,
'toKey': function toKey( this: { count: number; }, value: Foo ): string {
'toKey': function toKey( this: { count: number }, value: Foo ): string {
this.count += 1;
return value.name;
}
Expand Down
2 changes: 1 addition & 1 deletion map-reduce/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ function mapper( value: number ): number {
* Reducing function.
*
* @param acc - accumulated value
* @param v - array element
* @param value - array element
* @returns result
*/
function reducer( acc: number, value: number ): number {
Expand Down
2 changes: 1 addition & 1 deletion reduce/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import reduce = require( './index' );
* Callback function.
*
* @param acc - accumulated value
* @param v - array element
* @param value - array element
* @returns result
*/
function clbk( acc: number, value: number ): number {
Expand Down
2 changes: 1 addition & 1 deletion values-in/docs/types/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import objectValuesIn = require( './index' );

// The function returns an array of values...
{
objectValuesIn( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType Array<any>
objectValuesIn( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType any[]
}

// The compiler throws an error if the function is provided an incorrect number of arguments...
Expand Down

0 comments on commit d00482b

Please sign in to comment.