diff --git a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/test.ts index 9182094f940..b9bdd5d8021 100644 --- a/lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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 { - let arr: AccessorArrayLike; - arr = { + const arr: AccessorArrayLike = { '0': 1, '1': 2, '2': 3, diff --git a/lib/node_modules/@stdlib/array/base/accessors/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/accessors/docs/types/test.ts index da87eb686ec..4278d4cfade 100644 --- a/lib/node_modules/@stdlib/array/base/accessors/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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 { - let arr: AccessorArrayLike; - arr = { + const arr: AccessorArrayLike = { '0': 1, '1': 2, '2': 3, @@ -49,11 +48,10 @@ function accessorArray(): AccessorArrayLike { /** * Returns an array-like object. * -* @return array-like object +* @returns array-like object */ function arrayLike(): ArrayLike { - let arr: ArrayLike; - arr = { + const arr: ArrayLike = { '0': 1, '1': 2, '2': 3, diff --git a/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/test.ts index f426bb30b05..d3fe994e6d9 100644 --- a/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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 { - let arr: AccessorArrayLike; - arr = { + const arr: AccessorArrayLike = { '0': 1, '1': 2, '2': 3, @@ -49,11 +48,10 @@ function accessorArray(): AccessorArrayLike { /** * Returns an array-like object. * -* @return array-like object +* @returns array-like object */ function arrayLike(): ArrayLike { - let arr: ArrayLike; - arr = { + const arr: ArrayLike = { '0': 1, '1': 2, '2': 3, diff --git a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts index 528e5bbd6cf..e3127bd388b 100644 --- a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/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/lib/node_modules/@stdlib/array/base/filled2d-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled2d-by/docs/types/index.d.ts index 32fcda945b1..932d4885b60 100644 --- a/lib/node_modules/@stdlib/array/base/filled2d-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled2d-by/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape2D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/filled3d-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled3d-by/docs/types/index.d.ts index 6452032daa8..4877dd96752 100644 --- a/lib/node_modules/@stdlib/array/base/filled3d-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled3d-by/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/filled4d-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled4d-by/docs/types/index.d.ts index eb835f2b3d8..12fa1a1d449 100644 --- a/lib/node_modules/@stdlib/array/base/filled4d-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled4d-by/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape4D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/filled4d/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled4d/docs/types/index.d.ts index c7877f185ea..8f2f06decf2 100644 --- a/lib/node_modules/@stdlib/array/base/filled4d/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled4d/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape4D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/filled5d-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled5d-by/docs/types/index.d.ts index d5934f16276..1850dbe74ca 100644 --- a/lib/node_modules/@stdlib/array/base/filled5d-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled5d-by/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/filled5d/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled5d/docs/types/index.d.ts index dc46713a5dd..865386ffe85 100644 --- a/lib/node_modules/@stdlib/array/base/filled5d/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled5d/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/base/flatten-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/flatten-by/docs/types/test.ts index 65e81be634a..fe3bccd1408 100644 --- a/lib/node_modules/@stdlib/array/base/flatten-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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( value: T ): T { diff --git a/lib/node_modules/@stdlib/array/base/flatten2d-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/flatten2d-by/docs/types/test.ts index f31305d7509..1d4e2b9374b 100644 --- a/lib/node_modules/@stdlib/array/base/flatten2d-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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( value: T ): T { diff --git a/lib/node_modules/@stdlib/array/base/flatten3d-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/flatten3d-by/docs/types/test.ts index 7da978eafbf..968601de671 100644 --- a/lib/node_modules/@stdlib/array/base/flatten3d-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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( value: T ): T { diff --git a/lib/node_modules/@stdlib/array/base/flatten4d-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/flatten4d-by/docs/types/test.ts index 81a42dc7a5e..3161da12dd2 100644 --- a/lib/node_modules/@stdlib/array/base/flatten4d-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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( value: T ): T { diff --git a/lib/node_modules/@stdlib/array/base/flatten5d-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/flatten5d-by/docs/types/test.ts index 2631e7fee9e..d7fc9785dfe 100644 --- a/lib/node_modules/@stdlib/array/base/flatten5d-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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( value: T ): T { diff --git a/lib/node_modules/@stdlib/array/base/from-strided/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/from-strided/docs/types/test.ts index 279144ac6d2..01541c16e3a 100644 --- a/lib/node_modules/@stdlib/array/base/from-strided/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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 + 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/lib/node_modules/@stdlib/array/base/logspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/logspace/docs/types/index.d.ts index 70554668ed8..bc3fbd6b1d2 100644 --- a/lib/node_modules/@stdlib/array/base/logspace/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/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; +declare function logspace( a: number, b: number, len: number ): Array; // EXPORTS // diff --git a/lib/node_modules/@stdlib/array/base/mskreject-map/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/mskreject-map/docs/types/test.ts index e74d7981e3b..9a8b6104700 100644 --- a/lib/node_modules/@stdlib/array/base/mskreject-map/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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/lib/node_modules/@stdlib/array/base/zerosnd/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/zerosnd/docs/types/index.d.ts index 1519d7376fb..6ac1768b0e5 100644 --- a/lib/node_modules/@stdlib/array/base/zerosnd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/zerosnd/docs/types/index.d.ts @@ -20,7 +20,6 @@ /// -import { Collection } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; /** diff --git a/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts index 1ab3b13583f..eec5b8d0d94 100644 --- a/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/complex128/docs/types/index.d.ts @@ -22,7 +22,7 @@ /// -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( '@stdlib/array/buffer' ); @@ -38,7 +38,7 @@ interface LocaleOptions { * 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/lib/node_modules/@stdlib/array/filled-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/filled-by/docs/types/test.ts index 394ac496f33..bb876ed2009 100644 --- a/lib/node_modules/@stdlib/array/filled-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/array/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/lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts index ff51f43695b..a9166411867 100644 --- a/lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts @@ -20,7 +20,7 @@ /// -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/lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts index dcc45a44e95..8c5aa038ea0 100644 --- a/lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts @@ -212,7 +212,6 @@ declare function scalar2array( 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/lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts index 47352fd00eb..79522c1a365 100644 --- a/lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/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/lib/node_modules/@stdlib/array/to-view-iterator/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/to-view-iterator/docs/types/index.d.ts index 8d845c8863d..ed9929a9f83 100644 --- a/lib/node_modules/@stdlib/array/to-view-iterator/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/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; diff --git a/lib/node_modules/@stdlib/assert/is-complex-like/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-complex-like/docs/types/test.ts index ad67d8e0886..dc2af1d3b4f 100644 --- a/lib/node_modules/@stdlib/assert/is-complex-like/docs/types/test.ts +++ b/lib/node_modules/@stdlib/assert/is-complex-like/docs/types/test.ts @@ -16,9 +16,9 @@ * limitations under the License. */ -import isComplexLike = require( './index' ); import Complex128 = require( '@stdlib/complex/float64/ctor' ); import Complex64 = require( '@stdlib/complex/float32/ctor' ); +import isComplexLike = require( './index' ); // TESTS // diff --git a/lib/node_modules/@stdlib/assert/is-complex/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-complex/docs/types/test.ts index 48cde681568..461bac6d915 100644 --- a/lib/node_modules/@stdlib/assert/is-complex/docs/types/test.ts +++ b/lib/node_modules/@stdlib/assert/is-complex/docs/types/test.ts @@ -16,9 +16,9 @@ * limitations under the License. */ -import isComplex = require( './index' ); import Complex128 = require( '@stdlib/complex/float64/ctor' ); import Complex64 = require( '@stdlib/complex/float32/ctor' ); +import isComplex = require( './index' ); // TESTS // diff --git a/lib/node_modules/@stdlib/assert/is-prng-like/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-prng-like/docs/types/test.ts index e2322f8df55..614f7edc959 100644 --- a/lib/node_modules/@stdlib/assert/is-prng-like/docs/types/test.ts +++ b/lib/node_modules/@stdlib/assert/is-prng-like/docs/types/test.ts @@ -16,8 +16,8 @@ * limitations under the License. */ -import isPRNGLike = require( './index' ); import randu = require( '@stdlib/random/base/randu' ); +import isPRNGLike = require( './index' ); // TESTS // diff --git a/lib/node_modules/@stdlib/complex/base/parse/docs/types/test.ts b/lib/node_modules/@stdlib/complex/base/parse/docs/types/test.ts index d86d27354d1..2297860a4dc 100644 --- a/lib/node_modules/@stdlib/complex/base/parse/docs/types/test.ts +++ b/lib/node_modules/@stdlib/complex/base/parse/docs/types/test.ts @@ -24,7 +24,7 @@ import parse = require( './index' ); // The function returns a complex like object... { const str = '54 + 3i'; - parse( str ); // $ExpectType {re: number; im: number} | null + parse( str ); // $ExpectType ComplexLike | null } // The compiler throws an error if the function is provided insufficient arguments... diff --git a/lib/node_modules/@stdlib/complex/float32/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/docs/types/index.d.ts index cd8538b2f20..36161d62213 100644 --- a/lib/node_modules/@stdlib/complex/float32/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float32/docs/types/index.d.ts @@ -87,8 +87,8 @@ interface Namespace { * Parse a string representation of a 64-bit complex number. * * @param str - string representation of a complex number - * @returns Complex64 instance * @throws must provide a string recognized as a complex number + * @returns Complex64 instance * * @example * var str = '5 + 3i'; diff --git a/lib/node_modules/@stdlib/complex/float32/parse/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/parse/docs/types/index.d.ts index 0e5c757cab5..1cda6622322 100644 --- a/lib/node_modules/@stdlib/complex/float32/parse/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float32/parse/docs/types/index.d.ts @@ -29,8 +29,8 @@ import { Complex64 } from '@stdlib/types/complex'; * Parse a string representation of a 64-bit complex number. * * @param str - string representation of a complex number -* @returns Complex64 instance * @throws must provide a string recognized as a complex number +* @returns Complex64 instance * * @example * var str = '5 + 3i'; diff --git a/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts index 2aa8fe12068..5e9bd94e3ee 100644 --- a/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/promotion-rules/docs/types/index.d.ts @@ -88,8 +88,6 @@ declare function promotionRules( dtype1: string, dtype2: string ): null; /** * Returns a type promotion table displaying complex number data types with the smallest size and closest "kind" to which data types can be safely cast. * -* @param dtype1 - data type -* @param dtype2 - data type * @returns promotion rule table * * @example diff --git a/lib/node_modules/@stdlib/datasets/afinn-96/docs/types/test.ts b/lib/node_modules/@stdlib/datasets/afinn-96/docs/types/test.ts index bffbfb79db4..f4fe4b7866b 100644 --- a/lib/node_modules/@stdlib/datasets/afinn-96/docs/types/test.ts +++ b/lib/node_modules/@stdlib/datasets/afinn-96/docs/types/test.ts @@ -23,7 +23,7 @@ import afinn96 = require( './index' ); // The function returns an array of word ratings... { - afinn96(); // $ExpectType [string, number][] + afinn96(); // $ExpectType WordRating[] } // The compiler throws an error if the function is provided arguments... diff --git a/lib/node_modules/@stdlib/error/tools/docs/types/index.d.ts b/lib/node_modules/@stdlib/error/tools/docs/types/index.d.ts index e276acdb71b..b19424a9d70 100644 --- a/lib/node_modules/@stdlib/error/tools/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/error/tools/docs/types/index.d.ts @@ -47,7 +47,7 @@ interface Namespace { * Formats an error message for production. * * @param code - error code - * @param ...args - error message arguments + * @param args - error message arguments * @returns formatted error message * * @example diff --git a/lib/node_modules/@stdlib/error/tools/fmtprodmsg-factory/docs/types/index.d.ts b/lib/node_modules/@stdlib/error/tools/fmtprodmsg-factory/docs/types/index.d.ts index 8a90f292b10..8b3be3deabe 100644 --- a/lib/node_modules/@stdlib/error/tools/fmtprodmsg-factory/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/error/tools/fmtprodmsg-factory/docs/types/index.d.ts @@ -24,7 +24,7 @@ * Formats an error message for production. * * @param code - error code -* @param ...args - error message arguments +* @param args - error message arguments * @returns formatted error message */ type FormatProdErrorMsgFunction = ( code: any, ...args: Array ) => string; diff --git a/lib/node_modules/@stdlib/error/tools/fmtprodmsg/docs/types/index.d.ts b/lib/node_modules/@stdlib/error/tools/fmtprodmsg/docs/types/index.d.ts index 1596f5254e0..f5357b3d689 100644 --- a/lib/node_modules/@stdlib/error/tools/fmtprodmsg/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/error/tools/fmtprodmsg/docs/types/index.d.ts @@ -24,7 +24,7 @@ * Formats an error message for production. * * @param code - error code -* @param ...args - error message arguments +* @param args - error message arguments * @returns formatted error message * * @example diff --git a/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts index 6d26d273b4b..c15c2c2b0b8 100644 --- a/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts @@ -29,7 +29,7 @@ type Iterator = Iter | IterableIterator; * Iterator function * * @param iterator - input iterator -* @param ...args - function arguments +* @param args - function arguments * @returns hash value */ type IteratorFunction = ( iterator: Iterator, ...args: Array ) => any; diff --git a/lib/node_modules/@stdlib/lapack/base/dlamch/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/dlamch/docs/types/index.d.ts index 17cf2d14f08..e934b2366f9 100644 --- a/lib/node_modules/@stdlib/lapack/base/dlamch/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/lapack/base/dlamch/docs/types/index.d.ts @@ -54,7 +54,7 @@ type CMACH = 'E' | 'e' | 'S' | 's' | 'B' | 'b' | 'P' | 'p' | 'N' | 'n' | 'R' | ' * out = dlamch( 'B' ); * // returns 2.0 */ -declare function dlamch( x: CMACH | string ): number; +declare function dlamch( cmach: CMACH | string ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/rempio2/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/rempio2/docs/types/test.ts index fc608a7dba5..75954335dd4 100644 --- a/lib/node_modules/@stdlib/math/base/special/rempio2/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/rempio2/docs/types/test.ts @@ -18,8 +18,8 @@ /// -import rempio2 = require( './index' ); import { Collection } from '@stdlib/types/array'; +import rempio2 = require( './index' ); // TESTS // diff --git a/lib/node_modules/@stdlib/ndarray/base/broadcast-array/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/broadcast-array/docs/types/test.ts index 4041dc7a730..13dcd66fb08 100644 --- a/lib/node_modules/@stdlib/ndarray/base/broadcast-array/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/broadcast-array/docs/types/test.ts @@ -24,7 +24,7 @@ import broadcastArray = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/for-each/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/for-each/docs/types/test.ts index 2cdcd3bc3b9..283f1c5481e 100644 --- a/lib/node_modules/@stdlib/ndarray/base/for-each/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/for-each/docs/types/test.ts @@ -24,7 +24,7 @@ import forEach = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { @@ -50,6 +50,9 @@ function array(): ndarray { /** * Callback function. +* +* @param v - ndarray element +* @throws unexpected error */ function clbk( v: any ): void { if ( v !== v ) { diff --git a/lib/node_modules/@stdlib/ndarray/base/map/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/map/docs/types/test.ts index 7bc28dd409b..320d548cb07 100644 --- a/lib/node_modules/@stdlib/ndarray/base/map/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/map/docs/types/test.ts @@ -24,7 +24,7 @@ import map = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-array/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-array/docs/types/test.ts index d7a1a629f29..8dc469fbe03 100644 --- a/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-array/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-array/docs/types/test.ts @@ -24,7 +24,7 @@ import maybeBroadcastArray = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/ndarraylike2ndarray/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/ndarraylike2ndarray/docs/types/test.ts index beb2e84ec69..0aad95447a3 100644 --- a/lib/node_modules/@stdlib/ndarray/base/ndarraylike2ndarray/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/ndarraylike2ndarray/docs/types/test.ts @@ -24,7 +24,7 @@ import ndarraylike2ndarray = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): typedndarray { const obj: typedndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/ndarraylike2object/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/ndarraylike2object/docs/types/test.ts index ac04186a5ab..7bff00a2e61 100644 --- a/lib/node_modules/@stdlib/ndarray/base/ndarraylike2object/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/ndarraylike2object/docs/types/test.ts @@ -24,7 +24,7 @@ import ndarraylike2object = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/nullary/docs/types/test.ts index 0bc8d62f9ed..2d33fe95295 100644 --- a/lib/node_modules/@stdlib/ndarray/base/nullary/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/nullary/docs/types/test.ts @@ -24,7 +24,7 @@ import nullary = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/serialize-meta-data/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/serialize-meta-data/docs/types/test.ts index e3d3ddbfd1a..d68e1182538 100644 --- a/lib/node_modules/@stdlib/ndarray/base/serialize-meta-data/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/serialize-meta-data/docs/types/test.ts @@ -24,7 +24,7 @@ import serialize = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/types/test.ts index cb14e978c9e..67df3297a93 100644 --- a/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/types/test.ts @@ -24,7 +24,7 @@ import unaryBy = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/base/unary/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/base/unary/docs/types/test.ts index 0be6f9a2b74..626f5f2d126 100644 --- a/lib/node_modules/@stdlib/ndarray/base/unary/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/base/unary/docs/types/test.ts @@ -24,7 +24,7 @@ import unary = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/dispatch/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/dispatch/docs/types/test.ts index 3cba031ec76..edd6866a125 100644 --- a/lib/node_modules/@stdlib/ndarray/dispatch/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/dispatch/docs/types/test.ts @@ -30,7 +30,7 @@ import dispatch = require( './index' ); /** * Nullary callback. * -* @return input value +* @returns input value */ function nullary(): any { return 5.0; @@ -40,7 +40,7 @@ function nullary(): any { * Unary callback. * * @param x - input value -* @return input value +* @returns input value */ function unary( x: any ): any { return x; @@ -51,7 +51,7 @@ function unary( x: any ): any { * * @param x - input value * @param y - input value -* @return output value +* @returns output value */ function binary( x: number, y: number ): number { return x + y; @@ -63,7 +63,7 @@ function binary( x: number, y: number ): number { * @param x - input value * @param y - input value * @param z - input value -* @return output value +* @returns output value */ function ternary( x: number, y: number, z: number ): number { return x + y + z; @@ -76,7 +76,7 @@ function ternary( x: number, y: number, z: number ): number { * @param y - input value * @param z - input value * @param w - input value -* @return output value +* @returns output value */ function quaternary( x: number, y: number, z: number, w: number ): number { return x + y + z + w; @@ -88,7 +88,7 @@ function quaternary( x: number, y: number, z: number, w: number ): number { * @param shape - dimensions * @param idx - linear index * @param opts - options -* @return subscripts +* @returns subscripts */ function ind2sub( shape: ArrayLike, idx: number, opts?: any ): Array { let out; @@ -164,7 +164,7 @@ function ndarrayFcn( arrays: Array, fcn: ( x: any ) => any ): void { /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): ndarray { const obj: ndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/ind2sub/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/ind2sub/docs/types/test.ts index 0dcfa02f6ab..01bf62bddbf 100644 --- a/lib/node_modules/@stdlib/ndarray/ind2sub/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/ind2sub/docs/types/test.ts @@ -157,7 +157,7 @@ import ind2sub = require( './index' ); const opts = { 'order': 'row-major' }; - ind2sub.assign( shape, true opts, out ); // $ExpectError + ind2sub.assign( shape, true, opts, out ); // $ExpectError ind2sub.assign( shape, false opts, out ); // $ExpectError ind2sub.assign( shape, null opts, out ); // $ExpectError ind2sub.assign( shape, undefined opts, out ); // $ExpectError diff --git a/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/docs/types/test.ts index 26e102ddf98..8904767b632 100644 --- a/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/docs/types/test.ts @@ -24,7 +24,7 @@ import ndarraylike2ndarray = require( './index' ); /** * Mock function to create an ndarray-like object. * -* @return ndarray-like object +* @returns ndarray-like object */ function array(): typedndarray { const obj: typedndarray = { diff --git a/lib/node_modules/@stdlib/ndarray/slice-dimension-from/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/slice-dimension-from/docs/types/test.ts index 7c54601441e..9693bb399e6 100644 --- a/lib/node_modules/@stdlib/ndarray/slice-dimension-from/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/slice-dimension-from/docs/types/test.ts @@ -125,7 +125,7 @@ import sliceDimensionFrom = require( './index' ); sliceDimensionFrom( x, 1, {} ); // $ExpectError sliceDimensionFrom( x, 1, ( x: number ): number => x, 1 ); // $ExpectError - sliceDimensionFrom( x, 1, '5', {}; // $ExpectError + sliceDimensionFrom( x, 1, '5', {} ); // $ExpectError sliceDimensionFrom( x, 1, false, {}; // $ExpectError sliceDimensionFrom( x, 1, true, {}; // $ExpectError sliceDimensionFrom( x, 1, null, {}; // $ExpectError diff --git a/lib/node_modules/@stdlib/ndarray/slice-dimension-to/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/slice-dimension-to/docs/types/test.ts index 438de1b7a68..5c118fc3bbe 100644 --- a/lib/node_modules/@stdlib/ndarray/slice-dimension-to/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/slice-dimension-to/docs/types/test.ts @@ -125,14 +125,14 @@ import sliceDimensionTo = require( './index' ); sliceDimensionTo( x, 1, {} ); // $ExpectError sliceDimensionTo( x, 1, ( x: number ): number => x, 1 ); // $ExpectError - sliceDimensionTo( x, 1, '5', {}; // $ExpectError - sliceDimensionTo( x, 1, false, {}; // $ExpectError - sliceDimensionTo( x, 1, true, {}; // $ExpectError - sliceDimensionTo( x, 1, null, {}; // $ExpectError - sliceDimensionTo( x, 1, undefined, {}; // $ExpectError - sliceDimensionTo( x, 1, [ '5' ], {}; // $ExpectError - sliceDimensionTo( x, 1, {}, {}; // $ExpectError - sliceDimensionTo( x, 1, ( x: number ): number => x, {}; // $ExpectError + sliceDimensionTo( x, 1, '5', {} ); // $ExpectError + sliceDimensionTo( x, 1, false, {} ); // $ExpectError + sliceDimensionTo( x, 1, true, {} ); // $ExpectError + sliceDimensionTo( x, 1, null, {} ); // $ExpectError + sliceDimensionTo( x, 1, undefined, {} ); // $ExpectError + sliceDimensionTo( x, 1, [ '5' ], {} ); // $ExpectError + sliceDimensionTo( x, 1, {}, {} ); // $ExpectError + sliceDimensionTo( x, 1, ( x: number ): number => x, {} ); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not an object... diff --git a/lib/node_modules/@stdlib/ndarray/slice/docs/types/test.ts b/lib/node_modules/@stdlib/ndarray/slice/docs/types/test.ts index 05838ba59c7..16318b3b933 100644 --- a/lib/node_modules/@stdlib/ndarray/slice/docs/types/test.ts +++ b/lib/node_modules/@stdlib/ndarray/slice/docs/types/test.ts @@ -87,7 +87,7 @@ import slice = require( './index' ); slice( empty( 'uint32', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint32ndarray slice( empty( 'uint16', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint16ndarray slice( empty( 'uint8', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint8ndarray - slice( empty( 'uint8c', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType + slice( empty( 'uint8c', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint8cndarray slice( empty( 'float64', sh, order ), null, null, { 'strict': false } ); // $ExpectType float64ndarray slice( empty( 'float32', sh, order ), null, null, { 'strict': false } ); // $ExpectType float32ndarray diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/ctor/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/degenerate/ctor/docs/types/index.d.ts index fc37ff7c446..1335ffc8ea7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/ctor/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/ctor/docs/types/index.d.ts @@ -104,7 +104,7 @@ declare class Degenerate { */ logpdf( x: number ): number; - /** + /** * Evaluates the natural logarithm of the probability mass function (PMF). * * @param x - input value @@ -120,7 +120,7 @@ declare class Degenerate { */ mgf( t: number ): number; - /** + /** * Evaluates the probability density function (PDF). * * @param x - input value diff --git a/lib/node_modules/@stdlib/strided/base/map-by2/docs/types/test.ts b/lib/node_modules/@stdlib/strided/base/map-by2/docs/types/test.ts index d0487752bbf..e7af504fc68 100644 --- a/lib/node_modules/@stdlib/strided/base/map-by2/docs/types/test.ts +++ b/lib/node_modules/@stdlib/strided/base/map-by2/docs/types/test.ts @@ -21,6 +21,7 @@ import mapBy2 = require( './index' ); /** * Accessor callback. * +* @param values - accessed values * @returns accessed values */ function accessor( values: [ number, number ] ): [ number, number ] { diff --git a/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/test.ts b/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/test.ts index 10648d5c334..14f78eeebe7 100644 --- a/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/test.ts +++ b/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/test.ts @@ -26,7 +26,7 @@ import strided2object = require( './index' ); /** * Returns an array-like object supporting the get/set protocol. * -* @return array-like object +* @returns array-like object */ function accessorArray(): AccessorArrayLike { const arr: AccessorArrayLike = { @@ -50,7 +50,7 @@ function accessorArray(): AccessorArrayLike { /** * Returns an array-like object. * -* @return array-like object +* @returns array-like object */ function arrayLike(): ArrayLike { const arr: ArrayLike = { diff --git a/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/test.ts b/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/test.ts index e42d0501992..c89d79e16dd 100644 --- a/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/test.ts @@ -29,7 +29,7 @@ import dispatchBy = require( './index' ); /** * Nullary callback. * -* @return input value +* @returns input value */ function nullary(): any { return 5.0; @@ -39,7 +39,7 @@ function nullary(): any { * Unary callback. * * @param x - input value -* @return input value +* @returns input value */ function unary( x: any ): any { return x; @@ -50,7 +50,7 @@ function unary( x: any ): any { * * @param x - input value * @param y - input value -* @return output value +* @returns output value */ function binary( x: number, y: number ): number { return x + y; @@ -62,7 +62,7 @@ function binary( x: number, y: number ): number { * @param x - input value * @param y - input value * @param z - input value -* @return output value +* @returns output value */ function ternary( x: number, y: number, z: number ): number { return x + y + z; @@ -75,7 +75,7 @@ function ternary( x: number, y: number, z: number ): number { * @param y - input value * @param z - input value * @param w - input value -* @return output value +* @returns output value */ function quaternary( x: number, y: number, z: number, w: number ): number { return x + y + z + w; @@ -85,7 +85,7 @@ function quaternary( x: number, y: number, z: number, w: number ): number { * Identity function. * * @param values - input values -* @return input values +* @returns input values */ function identity( ...values: Array ): Array { return values; diff --git a/lib/node_modules/@stdlib/strided/dispatch/docs/types/test.ts b/lib/node_modules/@stdlib/strided/dispatch/docs/types/test.ts index 2eae2f0852f..0b92360e53d 100644 --- a/lib/node_modules/@stdlib/strided/dispatch/docs/types/test.ts +++ b/lib/node_modules/@stdlib/strided/dispatch/docs/types/test.ts @@ -29,7 +29,7 @@ import dispatch = require( './index' ); /** * Nullary callback. * -* @return input value +* @returns input value */ function nullary(): any { return 5.0; @@ -39,7 +39,7 @@ function nullary(): any { * Unary callback. * * @param x - input value -* @return input value +* @returns input value */ function unary( x: any ): any { return x; @@ -50,7 +50,7 @@ function unary( x: any ): any { * * @param x - input value * @param y - input value -* @return output value +* @returns output value */ function binary( x: number, y: number ): number { return x + y; @@ -62,7 +62,7 @@ function binary( x: number, y: number ): number { * @param x - input value * @param y - input value * @param z - input value -* @return output value +* @returns output value */ function ternary( x: number, y: number, z: number ): number { return x + y + z; @@ -75,7 +75,7 @@ function ternary( x: number, y: number, z: number ): number { * @param y - input value * @param z - input value * @param w - input value -* @return output value +* @returns output value */ function quaternary( x: number, y: number, z: number, w: number ): number { return x + y + z + w; diff --git a/lib/node_modules/@stdlib/string/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/base/docs/types/index.d.ts index 71ed7f524fe..16e54b0afb8 100644 --- a/lib/node_modules/@stdlib/string/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/string/base/docs/types/index.d.ts @@ -447,7 +447,7 @@ interface Namespace { * Generates string from a token array by interpolating values. * * @param tokens - string parts and format identifier objects - * @param ...args - variable values + * @param args - variable values * @throws invalid flags * @returns formatted string * diff --git a/lib/node_modules/@stdlib/string/base/format-interpolate/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/base/format-interpolate/docs/types/index.d.ts index 12881dee09b..f66d129bbca 100644 --- a/lib/node_modules/@stdlib/string/base/format-interpolate/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/string/base/format-interpolate/docs/types/index.d.ts @@ -54,7 +54,7 @@ type StringOrToken = string | FormatIdentifier; * Generates string from a token array by interpolating values. * * @param tokens - string parts and format identifier objects -* @param ...args - variable values +* @param args - variable values * @throws invalid flags * @returns formatted string * diff --git a/lib/node_modules/@stdlib/string/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/docs/types/index.d.ts index 9e7af70f737..1b643fcc47d 100644 --- a/lib/node_modules/@stdlib/string/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/string/docs/types/index.d.ts @@ -311,7 +311,7 @@ interface Namespace { * Inserts supplied variable values into a format string. * * @param str - input string - * @param ...args - variable values + * @param args - variable values * @throws invalid flags * @returns formatted string * diff --git a/lib/node_modules/@stdlib/string/format/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/format/docs/types/index.d.ts index 643f7905a58..cecb88d161c 100644 --- a/lib/node_modules/@stdlib/string/format/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/string/format/docs/types/index.d.ts @@ -22,7 +22,7 @@ * Inserts supplied variable values into a format string. * * @param str - input string -* @param ...args - variable values +* @param args - variable values * @throws invalid flags * @returns formatted string * diff --git a/lib/node_modules/@stdlib/utils/async/compose/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/async/compose/docs/types/index.d.ts index 3f212d83ecb..23770e65138 100644 --- a/lib/node_modules/@stdlib/utils/async/compose/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/utils/async/compose/docs/types/index.d.ts @@ -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 diff --git a/lib/node_modules/@stdlib/utils/async/every-by-right/docs/types/test.ts b/lib/node_modules/@stdlib/utils/async/every-by-right/docs/types/test.ts index 4c7078e6feb..d2cfdd62ece 100644 --- a/lib/node_modules/@stdlib/utils/async/every-by-right/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/async/every-by-right/docs/types/test.ts @@ -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; } diff --git a/lib/node_modules/@stdlib/utils/entries/docs/types/test.ts b/lib/node_modules/@stdlib/utils/entries/docs/types/test.ts index 632e61f186a..27e46bc60b1 100644 --- a/lib/node_modules/@stdlib/utils/entries/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/entries/docs/types/test.ts @@ -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... diff --git a/lib/node_modules/@stdlib/utils/every-in-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/every-in-by/docs/types/index.d.ts index 7f762dc4942..99fed79f0dd 100644 --- a/lib/node_modules/@stdlib/utils/every-in-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/utils/every-in-by/docs/types/index.d.ts @@ -65,9 +65,9 @@ type Predicate = Nullary | Unary | Binary | Ternary; /** * 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 */ diff --git a/lib/node_modules/@stdlib/utils/group/docs/types/test.ts b/lib/node_modules/@stdlib/utils/group/docs/types/test.ts index a08584f6781..c1c97a9f70d 100644 --- a/lib/node_modules/@stdlib/utils/group/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/group/docs/types/test.ts @@ -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; f: Collection; } 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; f: Collection; } } // The compiler throws an error if the function is provided a first argument which is not a collection... diff --git a/lib/node_modules/@stdlib/utils/key-by/docs/types/test.ts b/lib/node_modules/@stdlib/utils/key-by/docs/types/test.ts index fc62ec325b3..b25041da18c 100644 --- a/lib/node_modules/@stdlib/utils/key-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/key-by/docs/types/test.ts @@ -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; } diff --git a/lib/node_modules/@stdlib/utils/map-reduce/docs/types/test.ts b/lib/node_modules/@stdlib/utils/map-reduce/docs/types/test.ts index 0df0279c536..e1bd339e791 100644 --- a/lib/node_modules/@stdlib/utils/map-reduce/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/map-reduce/docs/types/test.ts @@ -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 { diff --git a/lib/node_modules/@stdlib/utils/reduce/docs/types/test.ts b/lib/node_modules/@stdlib/utils/reduce/docs/types/test.ts index 5b21b423264..85c6f4dd5d9 100644 --- a/lib/node_modules/@stdlib/utils/reduce/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/reduce/docs/types/test.ts @@ -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 { diff --git a/lib/node_modules/@stdlib/utils/values-in/docs/types/test.ts b/lib/node_modules/@stdlib/utils/values-in/docs/types/test.ts index 4a0591a120e..6837e859325 100644 --- a/lib/node_modules/@stdlib/utils/values-in/docs/types/test.ts +++ b/lib/node_modules/@stdlib/utils/values-in/docs/types/test.ts @@ -23,7 +23,7 @@ import objectValuesIn = require( './index' ); // The function returns an array of values... { - objectValuesIn( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType Array + objectValuesIn( { 'beep': 'boop', 'foo': 3.14 } ); // $ExpectType any[] } // The compiler throws an error if the function is provided an incorrect number of arguments... diff --git a/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/test.ts b/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/test.ts index 10648d5c334..14f78eeebe7 100644 --- a/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/test.ts +++ b/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/test.ts @@ -26,7 +26,7 @@ import strided2object = require( './index' ); /** * Returns an array-like object supporting the get/set protocol. * -* @return array-like object +* @returns array-like object */ function accessorArray(): AccessorArrayLike { const arr: AccessorArrayLike = { @@ -50,7 +50,7 @@ function accessorArray(): AccessorArrayLike { /** * Returns an array-like object. * -* @return array-like object +* @returns array-like object */ function arrayLike(): ArrayLike { const arr: ArrayLike = {