Auto-generated commit

stdlib-bot · stdlib-bot · commit 587f3db20990 · 2024-09-28T21:09:52.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -649,6 +649,7 @@ A total of 7 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)_
 -   [`7f368f6`](https://github.com/stdlib-js/stdlib/commit/7f368f6c3f4cea444a304a62616cea36a5f143eb) - **fix:** remove unused imports from TS declaration file _(by Philipp Burckhardt)_
 -   [`975147f`](https://github.com/stdlib-js/stdlib/commit/975147f3125c786ec1672acb3d2564ca16eaa790) - **docs:** fix TSDoc lint errors _(by Philipp Burckhardt)_
 -   [`fbe6651`](https://github.com/stdlib-js/stdlib/commit/fbe6651766e6c9bf9dd941c08fbefb2cab03de1c) - **feat:** add `Float32ArrayLE` to namespace _(by Athan Reines)_
diff --git a/base/accessor-getter/docs/types/test.ts b/base/accessor-getter/docs/types/test.ts
@@ -26,11 +26,10 @@ import getter = require( './index' );
 /**
 * Returns an array-like object supporting the get/set protocol.
 *
-* @return array-like object
+* @returns array-like object
 */
 function accessorArray(): AccessorArrayLike<number> {
-	let arr: AccessorArrayLike<number>;
-	arr = {
+	const arr: AccessorArrayLike<number> = {
 		'0': 1,
 		'1': 2,
 		'2': 3,
diff --git a/base/accessors/docs/types/test.ts b/base/accessors/docs/types/test.ts
@@ -26,11 +26,10 @@ import accessors = require( './index' );
 /**
 * Returns an array-like object supporting the get/set protocol.
 *
-* @return array-like object
+* @returns array-like object
 */
 function accessorArray(): AccessorArrayLike<number> {
-	let arr: AccessorArrayLike<number>;
-	arr = {
+	const arr: AccessorArrayLike<number> = {
 		'0': 1,
 		'1': 2,
 		'2': 3,
@@ -49,11 +48,10 @@ function accessorArray(): AccessorArrayLike<number> {
 /**
 * Returns an array-like object.
 *
-* @return array-like object
+* @returns array-like object
 */
 function arrayLike(): ArrayLike<number> {
-	let arr: ArrayLike<number>;
-	arr = {
+	const arr: ArrayLike<number> = {
 		'0': 1,
 		'1': 2,
 		'2': 3,
diff --git a/base/arraylike2object/docs/types/test.ts b/base/arraylike2object/docs/types/test.ts
@@ -26,11 +26,10 @@ import arraylike2object = require( './index' );
 /**
 * Returns an array-like object supporting the get/set protocol.
 *
-* @return array-like object
+* @returns array-like object
 */
 function accessorArray(): AccessorArrayLike<number> {
-	let arr: AccessorArrayLike<number>;
-	arr = {
+	const arr: AccessorArrayLike<number> = {
 		'0': 1,
 		'1': 2,
 		'2': 3,
@@ -49,11 +48,10 @@ function accessorArray(): AccessorArrayLike<number> {
 /**
 * Returns an array-like object.
 *
-* @return array-like object
+* @returns array-like object
 */
 function arrayLike(): ArrayLike<number> {
-	let arr: ArrayLike<number>;
-	arr = {
+	const arr: ArrayLike<number> = {
 		'0': 1,
 		'1': 2,
 		'2': 3,
diff --git a/base/docs/types/index.d.ts b/base/docs/types/index.d.ts
@@ -284,7 +284,7 @@ interface Namespace {
 	*     '2': 3,
 	*     '4': 4,
 	*     'length': 4
-	 };
+	* };
 	* var obj = ns.accessors( x );
 	* // returns {...}
 	*
@@ -385,7 +385,7 @@ interface Namespace {
 	*     '2': 3,
 	*     '4': 4,
 	*     'length': 4
-	 };
+	* };
 	* var obj = ns.arraylike2object( x );
 	* // returns {...}
 	*
diff --git a/base/filled2d-by/docs/types/index.d.ts b/base/filled2d-by/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape2D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/filled3d-by/docs/types/index.d.ts b/base/filled3d-by/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape3D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/filled4d-by/docs/types/index.d.ts b/base/filled4d-by/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape4D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/filled4d/docs/types/index.d.ts b/base/filled4d/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape4D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/filled5d-by/docs/types/index.d.ts b/base/filled5d-by/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape5D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/filled5d/docs/types/index.d.ts b/base/filled5d/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape5D } from '@stdlib/types/ndarray';
 
 /**
diff --git a/base/flatten-by/docs/types/test.ts b/base/flatten-by/docs/types/test.ts
@@ -21,7 +21,7 @@ import flattenBy = require( './index' );
 /**
 * Identity function.
 *
-* @param v - input value
+* @param value - input value
 * @returns input value
 */
 function identity<T>( value: T ): T {
diff --git a/base/flatten2d-by/docs/types/test.ts b/base/flatten2d-by/docs/types/test.ts
@@ -21,7 +21,7 @@ import flatten2dBy = require( './index' );
 /**
 * Identity function.
 *
-* @param v - input value
+* @param value - input value
 * @returns input value
 */
 function identity<T>( value: T ): T {
diff --git a/base/flatten3d-by/docs/types/test.ts b/base/flatten3d-by/docs/types/test.ts
@@ -21,7 +21,7 @@ import flatten3dBy = require( './index' );
 /**
 * Identity function.
 *
-* @param v - input value
+* @param value - input value
 * @returns input value
 */
 function identity<T>( value: T ): T {
diff --git a/base/flatten4d-by/docs/types/test.ts b/base/flatten4d-by/docs/types/test.ts
@@ -21,7 +21,7 @@ import flatten4dBy = require( './index' );
 /**
 * Identity function.
 *
-* @param v - input value
+* @param value - input value
 * @returns input value
 */
 function identity<T>( value: T ): T {
diff --git a/base/flatten5d-by/docs/types/test.ts b/base/flatten5d-by/docs/types/test.ts
@@ -21,7 +21,7 @@ import flatten5dBy = require( './index' );
 /**
 * Identity function.
 *
-* @param v - input value
+* @param value - input value
 * @returns input value
 */
 function identity<T>( value: T ): T {
diff --git a/base/from-strided/docs/types/test.ts b/base/from-strided/docs/types/test.ts
@@ -25,7 +25,7 @@ import strided2array = require( './index' );
 {
 	const x = [ 1.0, 2.0, 3.0, 4.0 ];
 
-	strided2array( x.length, x, 1, 0 ); // $ExpectType Array<number>
+	strided2array( x.length, x, 1, 0 ); // $ExpectType number[]
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a number...
diff --git a/base/logspace/docs/types/index.d.ts b/base/logspace/docs/types/index.d.ts
@@ -30,7 +30,7 @@
 * var arr = logspace( 0, 2, 6 );
 * // returns [ 1, ~2.5, ~6.31, ~15.85, ~39.81, 100 ]
 */
-declare function logspace( x1: number, x2: number, len: number ): Array<number>;
+declare function logspace( a: number, b: number, len: number ): Array<number>;
 
 
 // EXPORTS //
diff --git a/base/mskreject-map/docs/types/test.ts b/base/mskreject-map/docs/types/test.ts
@@ -21,10 +21,22 @@ import mskrejectMap = require( './index' );
 
 // FUNCTIONS //
 
+/**
+* Multiplies a value by two.
+*
+* @param val - input value
+* @returns result
+*/
 function timesTwo( val: number ): number {
 	return val * 2;
 }
 
+/**
+* Identity function.
+*
+* @param val - input value
+* @returns input value
+*/
 function identity( val: string ): string {
 	return val;
 }
diff --git a/base/zerosnd/docs/types/index.d.ts b/base/zerosnd/docs/types/index.d.ts
@@ -20,7 +20,6 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
 import { Shape } from '@stdlib/types/ndarray';
 
 /**
diff --git a/complex128/docs/types/index.d.ts b/complex128/docs/types/index.d.ts
@@ -22,7 +22,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+import { Iterator as Iter, IterableIterator, TypedIterator } from '@stdlib/types/iter';
 import { ArrayLike, RealOrComplexTypedArray, Complex128Array as Complex128ArrayInterface } from '@stdlib/types/array';
 import { ComplexLike, Complex128 } from '@stdlib/types/complex';
 import ArrayBuffer = require( './../../../buffer' );
@@ -38,7 +38,7 @@ interface LocaleOptions<T = unknown> {
 	* Configuration property.
 	*/
 	[ key: string | symbol | number ]: T | undefined;
-};
+}
 
 /**
 * Callback invoked for each element in a source object.
@@ -1319,7 +1319,7 @@ declare class Complex128Array implements Complex128ArrayInterface {
 	* im = imag( z );
 	* // returns -3.0
 	*/
-	subarray( begin?: number, end?: number ): Complex64Array;
+	subarray( begin?: number, end?: number ): Complex128Array;
 
 	/**
 	* Serializes an array as a locale-specific string.
diff --git a/filled-by/docs/types/test.ts b/filled-by/docs/types/test.ts
@@ -93,23 +93,23 @@ function clbk( i: number ): number {
 	filledarrayBy( it, 'uint8c', clbk, {} ); // $ExpectType ArrayOrTypedArray
 
 	const buf = new ArrayBuffer( 32 );
-	filledarrayBy( buf, clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 
-	filledarrayBy( buf, 'uint32', clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, 'uint32', clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, 'uint32', clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, 'uint32', clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 
-	filledarrayBy( buf, 8, clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, 8, clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, 8, clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, 8, clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 
-	filledarrayBy( buf, 8, 'uint16', clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, 8, 'uint16', clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, 8, 'uint16', clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, 8, 'uint16', clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 
-	filledarrayBy( buf, 8, 2, clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, 8, 2, clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, 8, 2, clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, 8, 2, clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 
-	filledarrayBy( buf, 8, 2, 'int16', clbk ); // $ExpectType RealOrComplexTypedArray
-	filledarrayBy( buf, 8, 2, 'int16', clbk, {} ); // $ExpectType RealOrComplexTypedArray
+	filledarrayBy( buf, 8, 2, 'int16', clbk ); // $ExpectType RealOrComplexTypedArray | BooleanArray
+	filledarrayBy( buf, 8, 2, 'int16', clbk, {} ); // $ExpectType RealOrComplexTypedArray | BooleanArray
 }
 
 // The compiler throws an error if a callback function argument is not a function...
diff --git a/from-iterator/docs/types/index.d.ts b/from-iterator/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { TypedIterator as Iter, TypedIterableIterator } from '@stdlib/types/iter';
+import { TypedIterator as Iter } from '@stdlib/types/iter';
 import { Collection } from '@stdlib/types/array';
 
 // Define a union type representing both iterable and non-iterable iterators:
diff --git a/from-scalar/docs/types/index.d.ts b/from-scalar/docs/types/index.d.ts
@@ -212,7 +212,6 @@ declare function scalar2array<T = unknown>( value: T, dtype: 'generic' ): Array<
 * Returns a single-element array containing a provided scalar value.
 *
 * @param value - scalar value
-* @param dtype - output array data type
 * @returns output array
 *
 * @example
@@ -225,7 +224,6 @@ declare function scalar2array( value: number ): Float64Array;
 * Returns a single-element array containing a provided scalar value.
 *
 * @param value - scalar value
-* @param dtype - output array data type
 * @returns output array
 *
 * @example
@@ -238,7 +236,6 @@ declare function scalar2array( value: boolean ): BooleanArray;
 * Returns a single-element array containing a provided scalar value.
 *
 * @param value - scalar value
-* @param dtype - output array data type
 * @returns output array
 *
 * @example
@@ -255,7 +252,6 @@ declare function scalar2array( value: Complex64 ): Complex64Array;
 * Returns a single-element array containing a provided scalar value.
 *
 * @param value - scalar value
-* @param dtype - output array data type
 * @returns output array
 *
 * @example
diff --git a/nans-like/docs/types/index.d.ts b/nans-like/docs/types/index.d.ts
@@ -88,7 +88,7 @@ declare function nansLike( x: AnyArray, dtype: 'complex128' ): Complex128Array;
 /**
 * Creates an array filled with NaNs and having the same length as a provided input array.
 *
- ## Notes
+* ## Notes
 *
 * -   Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
 *
@@ -188,7 +188,7 @@ declare function nansLike( x: Float32Array, dtype?: DataType ): Float32Array;
 * -   `complex64`: single-precision complex floating-point numbers
 * -   `generic`: generic JavaScript values
 *
- ## Notes
+* ## Notes
 *
 * -   Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
 *
@@ -218,7 +218,7 @@ declare function nansLike( x: Complex128Array, dtype?: DataType ): Complex128Arr
 * -   `complex64`: single-precision complex floating-point numbers
 * -   `generic`: generic JavaScript values
 *
- ## Notes
+* ## Notes
 *
 * -   Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
 *
diff --git a/to-view-iterator/docs/types/index.d.ts b/to-view-iterator/docs/types/index.d.ts
@@ -82,7 +82,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary;
 * function fcn( v ) {
 *     return v * 10.0;
 * }
-
+*
 * var iter = arrayview2iterator( [ 1, 2, 3, 4 ], fcn );
 *
 * var v = iter.next().value;

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import flattenBy = require( './index' );`
`21`	`21`	`/**`
`22`	`22`	`* Identity function.`
`23`	`23`	`*`
`24`		`-* @param v - input value`
	`24`	`+* @param value - input value`
`25`	`25`	`* @returns input value`
`26`	`26`	`*/`
`27`	`27`	`function identity<T>( value: T ): T {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import flatten2dBy = require( './index' );`
`21`	`21`	`/**`
`22`	`22`	`* Identity function.`
`23`	`23`	`*`
`24`		`-* @param v - input value`
	`24`	`+* @param value - input value`
`25`	`25`	`* @returns input value`
`26`	`26`	`*/`
`27`	`27`	`function identity<T>( value: T ): T {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import flatten3dBy = require( './index' );`
`21`	`21`	`/**`
`22`	`22`	`* Identity function.`
`23`	`23`	`*`
`24`		`-* @param v - input value`
	`24`	`+* @param value - input value`
`25`	`25`	`* @returns input value`
`26`	`26`	`*/`
`27`	`27`	`function identity<T>( value: T ): T {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import flatten4dBy = require( './index' );`
`21`	`21`	`/**`
`22`	`22`	`* Identity function.`
`23`	`23`	`*`
`24`		`-* @param v - input value`
	`24`	`+* @param value - input value`
`25`	`25`	`* @returns input value`
`26`	`26`	`*/`
`27`	`27`	`function identity<T>( value: T ): T {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ import flatten5dBy = require( './index' );`
`21`	`21`	`/**`
`22`	`22`	`* Identity function.`
`23`	`23`	`*`
`24`		`-* @param v - input value`
	`24`	`+* @param value - input value`
`25`	`25`	`* @returns input value`
`26`	`26`	`*/`
`27`	`27`	`function identity<T>( value: T ): T {`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import strided2array = require( './index' );`
`25`	`25`	`{`
`26`	`26`	`const x = [ 1.0, 2.0, 3.0, 4.0 ];`
`27`	`27`
`28`		`- strided2array( x.length, x, 1, 0 ); // $ExpectType Array<number>`
	`28`	`+ strided2array( x.length, x, 1, 0 ); // $ExpectType number[]`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`// The compiler throws an error if the function is provided a first argument which is not a number...`
Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,6 @@ declare function scalar2array<T = unknown>( value: T, dtype: 'generic' ): Array<`
`212`	`212`	`* Returns a single-element array containing a provided scalar value.`
`213`	`213`	`*`
`214`	`214`	`* @param value - scalar value`
`215`		`-* @param dtype - output array data type`
`216`	`215`	`* @returns output array`
`217`	`216`	`*`
`218`	`217`	`* @example`
`@@ -225,7 +224,6 @@ declare function scalar2array( value: number ): Float64Array;`
`225`	`224`	`* Returns a single-element array containing a provided scalar value.`
`226`	`225`	`*`
`227`	`226`	`* @param value - scalar value`
`228`		`-* @param dtype - output array data type`
`229`	`227`	`* @returns output array`
`230`	`228`	`*`
`231`	`229`	`* @example`
`@@ -238,7 +236,6 @@ declare function scalar2array( value: boolean ): BooleanArray;`
`238`	`236`	`* Returns a single-element array containing a provided scalar value.`
`239`	`237`	`*`
`240`	`238`	`* @param value - scalar value`
`241`		`-* @param dtype - output array data type`
`242`	`239`	`* @returns output array`
`243`	`240`	`*`
`244`	`241`	`* @example`
`@@ -255,7 +252,6 @@ declare function scalar2array( value: Complex64 ): Complex64Array;`
`255`	`252`	`* Returns a single-element array containing a provided scalar value.`
`256`	`253`	`*`
`257`	`254`	`* @param value - scalar value`
`258`		`-* @param dtype - output array data type`
`259`	`255`	`* @returns output array`
`260`	`256`	`*`
`261`	`257`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ declare function nansLike( x: AnyArray, dtype: 'complex128' ): Complex128Array;`
`88`	`88`	`/**`
`89`	`89`	`* Creates an array filled with NaNs and having the same length as a provided input array.`
`90`	`90`	`*`
`91`		`- ## Notes`
	`91`	`+* ## Notes`
`92`	`92`	`*`
`93`	`93`	* - Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
`94`	`94`	`*`
`@@ -188,7 +188,7 @@ declare function nansLike( x: Float32Array, dtype?: DataType ): Float32Array;`
`188`	`188`	* - `complex64`: single-precision complex floating-point numbers
`189`	`189`	* - `generic`: generic JavaScript values
`190`	`190`	`*`
`191`		`- ## Notes`
	`191`	`+* ## Notes`
`192`	`192`	`*`
`193`	`193`	* - Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
`194`	`194`	`*`
`@@ -218,7 +218,7 @@ declare function nansLike( x: Complex128Array, dtype?: DataType ): Complex128Arr`
`218`	`218`	* - `complex64`: single-precision complex floating-point numbers
`219`	`219`	* - `generic`: generic JavaScript values
`220`	`220`	`*`
`221`		`- ## Notes`
	`221`	`+* ## Notes`
`222`	`222`	`*`
`223`	`223`	* - Each element of the returned array has a real component equal to `NaN` and an imaginary component equal to `NaN`.
`224`	`224`	`*`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ type MapFunction = Nullary \| Unary \| Binary \| Ternary;`
`82`	`82`	`* function fcn( v ) {`
`83`	`83`	`* return v * 10.0;`
`84`	`84`	`* }`
`85`		`-`
	`85`	`+*`
`86`	`86`	`* var iter = arrayview2iterator( [ 1, 2, 3, 4 ], fcn );`
`87`	`87`	`*`
`88`	`88`	`* var v = iter.next().value;`