[doc] TSDoc Error During Build #350

api-extractor.json

@@ -415,7 +415,7 @@
      */
     "tsdocMessageReporting": {
       "default": {
-        "logLevel": "none"
+        "logLevel": "warning"
         // "addToApiReportFile": false
       }
 

lib/src/array/every.ts

@@ -21,7 +21,7 @@ import { ArrPredicateCallbackFn, ArrPredicateCallbackFn2 } from "./callbacks";
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.
@@ -82,7 +82,7 @@ export const arrEvery: <T, E extends T>(theArray: ArrayLike<T>, callbackFn: ArrP
  * @typeParam T - Identifies the base type of the elements.
  * @typeParam E - Identifies a more specific instance of the base array type.
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.

lib/src/array/find.ts

@@ -43,7 +43,7 @@ import { ArrPredicateCallbackFn, ArrPredicateCallbackFn2 } from "./callbacks";
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.
@@ -108,7 +108,7 @@ export const arrFind =  (/*#__PURE__*/_unwrapFunctionWithPoly("find", ArrProto,
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.
@@ -180,7 +180,7 @@ export const arrFindIndex = (/*#__PURE__*/_unwrapFunctionWithPoly("findIndex", A
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.
@@ -244,7 +244,7 @@ export const arrFindLast = (/*#__PURE__*/_unwrapFunctionWithPoly("findLast", Arr
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.

lib/src/array/forEach.ts

@@ -19,8 +19,8 @@ import { CALL, LENGTH } from "../internal/constants";
  * @group ArrayLike
  * @typeParam T - Identifies the element type of the array
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackfn A `synchronous` function that accepts up to three arguments. arrForEach calls the callbackfn function one time for each element in the array.
- * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, null or undefined
+ * @param callbackfn - A `synchronous` function that accepts up to three arguments. arrForEach calls the callbackfn function one time for each element in the array.
+ * @param thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, null or undefined
  * the array will be used as the this value.
  * @remarks
  * arrForEach expects a `synchronous` function.

lib/src/array/from.ts

@@ -23,7 +23,7 @@ import { ArrFromMapFn } from "./callbacks";
  * @param mapFn - A {@link ArrFromMapFn | mapping function} to call on every element of the array. If provided, every
  * value to be added to the array is first passed through this map function, and the return
  * value is added to the array instead. The function is called with the following arguments:
- * @param thisArg Value of 'this' used to invoke the mapfn.
+ * @param thisArg - Value of 'this' used to invoke the mapfn.
  * @example
  * ```ts
  * arrFrom("Hello");

lib/src/array/includes.ts

@@ -19,10 +19,10 @@ import { polyArrIncludes } from "../polyfills/array";
  * @param theArray - The array or array like object of elements to be searched.
  * @param searchElement - The value to search for
  * @param fromIndex - The optional Zero-based index at which to start searching, converted to an integer.
- * - Negative index counts back from the end of the array — if fromIndex < 0, fromIndex + array.length
+ * - Negative index counts back from the end of the array — if fromIndex \< 0, fromIndex + array.length
  * is used. However, the array is still searched from front to back in this case.
- * - If fromIndex < -array.length or fromIndex is omitted, 0 is used, causing the entire array to be searched.
- * - If fromIndex >= array.length, the array is not searched and false is returned.
+ * - If fromIndex \< -array.length or fromIndex is omitted, 0 is used, causing the entire array to be searched.
+ * - If fromIndex \>= array.length, the array is not searched and false is returned.
  * @returns A boolean value which is true if the value searchElement is found within the array (or the part of
  * the array indicated by the index fromIndex, if specified).
  * @example
@@ -54,10 +54,10 @@ export const arrIncludes: <T>(theArray: ArrayLike<T>, searchElement: T, fromInde
  * @param theArray - The array or array like object of elements to be searched.
  * @param searchElement - The value to search for
  * @param fromIndex - The optional Zero-based index at which to start searching, converted to an integer.
- * - Negative index counts back from the end of the array — if fromIndex < 0, fromIndex + array.length
+ * - Negative index counts back from the end of the array — if fromIndex \< 0, fromIndex + array.length
  * is used. However, the array is still searched from front to back in this case.
- * - If fromIndex < -array.length or fromIndex is omitted, 0 is used, causing the entire array to be searched.
- * - If fromIndex >= array.length, the array is not searched and false is returned.
+ * - If fromIndex \< -array.length or fromIndex is omitted, 0 is used, causing the entire array to be searched.
+ * - If fromIndex \>= array.length, the array is not searched and false is returned.
  * @returns A boolean value which is true if the value searchElement is found within the array (or the part of
  * the array indicated by the index fromIndex, if specified).
  * @example

lib/src/array/indexOf.ts

@@ -96,11 +96,11 @@ export const arrIndexOf: <T>(theArray: ArrayLike<T>, searchElement: T, fromIndex
  * @param theArray - The array or array like object of elements to be searched.
  * @param searchElement - The element to locate in the array.
  * @param fromIndex - Zero-based index at which to start searching backwards, converted to an integer.
- * - Negative index counts back from the end of the array — if fromIndex < 0, fromIndex + array.length is used.
- * - If fromIndex < -array.length, the array is not searched and -1 is returned. You can think of it conceptually
+ * - Negative index counts back from the end of the array — if fromIndex \< 0, fromIndex + array.length is used.
+ * - If fromIndex \< -array.length, the array is not searched and -1 is returned. You can think of it conceptually
  * as starting at a nonexistent position before the beginning of the array and going backwards from there. There
  * are no array elements on the way, so searchElement is never found.
- * - If fromIndex >= array.length or fromIndex is omitted, array.length - 1 is used, causing the entire array to
+ * - If fromIndex \>= array.length or fromIndex is omitted, array.length - 1 is used, causing the entire array to
  * be searched. You can think of it conceptually as starting at a nonexistent position beyond the end of the array and going backwards from there. It eventually reaches the real end position of the array, at which point it starts searching backwards through the actual array elements.
  * @return The first index of the element in the array; -1 if not found.
  * @example

lib/src/array/reduce.ts

@@ -37,8 +37,8 @@ export type ArrReduceCallbackFn<T, R = T> = (previousValue: T | R, currentValue:
  * @group ArrayLike
  * @typeParam T - Identifies the type of array elements
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+ * @param callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+ * @param initialValue - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
  * @returns The value that results from running the "reducer" callback function to completion over the entire array.
  * @example
  * ```ts

lib/src/array/slice.ts

@@ -27,15 +27,15 @@ import { ArrSlice, CALL, NULL_VALUE } from "../internal/constants";
  * @since 0.9.3
  * @group Array
  * @group ArrayLike
- * @param start Zero-based index at which to start extraction, converted to an integer.
- * - Negative index counts back from the end of the array — if start < 0, start + array.length is used.
- * - If start < -array.length or start is omitted, 0 is used.
- * - If start >= array.length, nothing is extracted.
- * @param end Zero-based index at which to end extraction, converted to an integer. slice() extracts
+ * @param start - Zero-based index at which to start extraction, converted to an integer.
+ * - Negative index counts back from the end of the array — if start \< 0, start + array.length is used.
+ * - If start \< -array.length or start is omitted, 0 is used.
+ * - If start \>= array.length, nothing is extracted.
+ * @param end - Zero-based index at which to end extraction, converted to an integer. slice() extracts
  * up to but not including end.
- * - Negative index counts back from the end of the array — if end < 0, end + array.length is used.
- * - If end < -array.length, 0 is used.
- * - If end >= array.length or end is omitted, array.length is used, causing all elements until the
+ * - Negative index counts back from the end of the array — if end \< 0, end + array.length is used.
+ * - If end \< -array.length, 0 is used.
+ * - If end \>= array.length or end is omitted, array.length is used, causing all elements until the
  * end to be extracted.
  * - If end is positioned before or at start after normalization, nothing is extracted.
  * @example

lib/src/array/some.ts

@@ -39,7 +39,7 @@ import { ArrPredicateCallbackFn, ArrPredicateCallbackFn2 } from "./callbacks";
  * @typeParam T - Identifies the base type of array elements
  * @typeParam E - Identifies a more specific instance of the base array type
  * @param theArray - The array or array like object of elements to be searched.
- * @param callbackFn A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
+ * @param callbackFn - A function that accepts up to three arguments of type {@link ArrPredicateCallbackFn} or
  * {@link ArrPredicateCallbackFn2}. The predicate function is called for each element in the thArray until
  * the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  * @param thisArg - A value to use as this when executing callbackFn. Defaults to the array if not provided.

lib/src/funcs/funcs.ts

@@ -72,9 +72,9 @@ export function fnApply<F extends (...args: any) => any, T>(fn: F, thisArg: T, a
 
 /**
  * The `fnCall` function calls the function with the given `thisArg` as the `this` value and with
- * al of the `_args` provided as it's `arguments.
+ * al of the `_args` provided as it's `arguments`.
  *
- * > This is almost identical to `fnApply`, except that the function arguments are passed to `fnCall`
+ * Note: This is almost identical to `fnApply`, except that the function arguments are passed to `fnCall`
  * individually as a list, while with `fnApply` that are combined into a single array argument.
  *
  * Normally, when calling a function, the value of `this` inside the function is the object that the

lib/src/funcs/readArgs.ts

@@ -20,18 +20,18 @@ let _iterSymbol: ICachedValue<symbol>;
  * Read the arguments from the provided array, iterator /  or generator function
  * When processing an Iterable and a negative start or end is provided the entire
  * iterator will be processed into an array before applying the start / end restrictions
- * and when undefined or >= 0 any iterator will not be fully processed.
+ * and when undefined or \>= 0 any iterator will not be fully processed.
  * @param theArgs - The arguments to process, may be ArrayLike or an Iterable
- * @param start Zero-based index at which to start extraction, converted to an integer.
+ * @param start - Zero-based index at which to start extraction, converted to an integer.
  * - Negative index counts back from the end of the array or iteration
- * - if start < 0, start + (array.length || iterator.count) is used.
- * - If start < -array.length or start is omitted, 0 is used.
- * - If start >= array.length, nothing is extracted.
- * @param end Zero-based index at which to end extraction, converted to an integer. readArgs() extracts
+ * - if start \< 0, start + (array.length || iterator.count) is used.
+ * - If start \< -array.length or start is omitted, 0 is used.
+ * - If start \>= array.length, nothing is extracted.
+ * @param end - Zero-based index at which to end extraction, converted to an integer. readArgs() extracts
  * up to but not including end.
- * - Negative index counts back from the end of the array — if end < 0, end + array.length is used.
- * - If end < -array.length, 0 is used.
- * - If end >= array.length or end is omitted, array.length is used, causing all elements until the
+ * - Negative index counts back from the end of the array — if end \< 0, end + array.length is used.
+ * - If end \< -array.length, 0 is used.
+ * - If end \>= array.length or end is omitted, array.length is used, causing all elements until the
  * end to be extracted.
  * - If end is positioned before or at start after normalization, nothing is extracted.
  * @returns A new array with the extracted elements