chore: WIP

Author: lambdalisue

chain.ts

@@ -1,8 +1,9 @@
 /**
  * Chains multiple iterables together.
  *
- * @param iterables The iterables to chain.
+ * @param iterables - The iterables to chain.
  * @returns The chained iterable.
+ * @see {@link module:iterutil/async/chain.chain} for the asynchronous version.
  *
  * @example
  * ```ts
@@ -12,8 +13,6 @@
  * console.log([...iter]); // [1, 2, 3, 4]
  * ```
  *
- * It supports chaining malformed iterables.
- *
  * @example
  * ```ts
  * import { chain } from "@core/iterutil/chain";

chunked.ts

@@ -1,9 +1,10 @@
 /**
  * Chunks an iterable into arrays of a given size.
  *
- * @param iterable The iterable to chunk.
- * @param size The size of each chunk.
- * @returns The chunked iterable.
+ * @param iterable - The iterable to chunk.
+ * @param size - The size of each chunk.
+ * @return The chunked iterable.
+ * @see {@link module:iterutil/async/chunked.chunked} for the asynchronous version.
  *
  * @example
  * ```ts

compact.ts

@@ -1,8 +1,11 @@
 /**
- * Removes all nullish values from an iterable.
+ * Removes all nullish ({@codelink null} or {@codelink undefined}) values from an iterable.
  *
- * @param iterable The iterable to compact.
+ * @param iterable - The iterable to compact.
  * @returns The compacted iterable.
+ * @see {@link module:iterutil/async/compact.compact} for the asynchronous version.
+ * @see {@link module:iterutil/compress.compress} to select elements based on a selector iterable.
+ * @see {@link module:iterutil/filter.filter} to remove values based on a predicate.
  *
  * @example
  * ```ts

compress.ts

@@ -1,9 +1,12 @@
 /**
  * Compress an iterable by selecting elements using a selector iterable.
  *
- * @param iterable The iterable to compress.
- * @param selectors The selectors to use.
+ * @param iterable - The iterable to compress.
+ * @param selectors - The selectors to use.
  * @returns The compressed iterable.
+ * @see {@link module:iterutil/async/compress.compress} for the asynchronous version.
+ * @see {@link module:iterutil/compact.compact} to remove nullish values from an iterable.
+ * @see {@link module:iterutil/filter.filter} to remove values based on a predicate.
  *
  * @example
  * ```ts

count.ts

@@ -1,9 +1,11 @@
 /**
  * Generates an infinite sequence of numbers starting from `start` with a step of `step`.
  *
- * @param start The number to start the sequence from.
- * @param step The step between each number in the sequence.
+ * @param - start The number to start the sequence from.
+ * @param - step The step between each number in the sequence.
  * @returns The count iterable.
+ * @see {@link module:iterutil/take.take} to take a specific number of elements from the iterable.
+ * @see {@link module:iterutil/range.range} for a finite version of this function.
  *
  * @example
  * ```ts

cycle.ts

@@ -1,8 +1,10 @@
 /**
  * Returns an infinite iterable that cycles through the given iterable.
  *
- * @param iterable The iterable to cycle.
+ * @param iterable - The iterable to cycle.
  * @returns The cycled iterable.
+ * @see {@link module:iterutil/async/cycle.cycle} for the asynchronous version.
+ * @see {@link module:iterutil/take.take} to take a specific number of elements from the iterable.
  *
  * @example
  * ```ts

drop.ts

@@ -1,11 +1,14 @@
 /**
  * Drops the first `limit` items from the iterable.
  *
- * It throws an error if `limit` is less than 0.
- *
- * @param iterable The iterable to drop items from.
- * @param limit The number of items to drop.
+ * @param iterable - The iterable to drop items from.
+ * @param limit - The number of items to drop. It must be 0 or positive safe integer.
  * @returns The iterable with the first `limit` items dropped.
+ * @throws {DropLimitError} If the limit is not a safe integer or is negative.
+ * @see {@link module:iterutil/async/drop.drop} for the asynchronous version.
+ * @see {@link module:iterutil/drop-while.dropWhile} to drop elements while a predicate is true.
+ * @see {@link module:iterutil/take.take} to take a specific number of elements from the iterable.
+ * @see {@link module:iterutil/take-while.takeWhile} to take elements while a predicate is true.
  *
  * @example
  * ```ts

drop_while.ts

@@ -1,12 +1,16 @@
 /**
- * Drops elements from the iterable while the predicate returns true.
+ * Drops elements from the iterable while the predicate function returns true.
  *
  * The first element that does not match the predicate is included in the output.
  * If the predicate never returns false, the output will be an empty iterable.
  *
- * @param iterable The iterable to drop elements from.
- * @param fn The predicate function to drop elements with.
+ * @param iterable - The iterable to drop elements from.
+ * @param fn - The predicate function to drop elements with.
  * @returns The iterable with elements dropped while the predicate returns true.
+ * @see {@link module:iterutil/async/drop-while.dropWhile} for the asynchronous version.
+ * @see {@link module:iterutil/drop.drop} to drop a specific number of elements from the iterable.
+ * @see {@link module:iterutil/take.take} to take a specific number of elements from the iterable.
+ * @see {@link module:iterutil/take-while.takeWhile} to take elements while a predicate is true.
  *
  * @example
  * ```ts

enumerate.ts

@@ -1,9 +1,13 @@
 /**
  * Enumerate an iterable.
  *
- * @param iterable The iterable to enumerate.
- * @param start The starting index.
+ * @param iterable - The iterable to enumerate.
+ * @param start - The starting index.
  * @returns An iterable of index-value pairs.
+ * @see {@link module:iterutil/async/enumerate.enumerate} for the asynchronous version.
+ * @see {@link module:iterutil/zipped.zipped} to zip multiple iterables together.
+ * @see {@link module:iterutil/count.count} to generate an infinite sequence of numbers.
+ * @see {@link module:iterutil/range.range} to generate a finite sequence of numbers.
  *
  * @example
  * ```ts

every.ts

@@ -1,9 +1,11 @@
 /**
  * Returns true if every element in the iterable satisfies the provided testing function.
  *
- * @param iterable The iterable to test.
- * @param fn The function to test with.
+ * @param iterable - The iterable to test.
+ * @param fn - The function to test with.
  * @returns True if every element in the iterable satisfies the provided testing function, otherwise false.
+ * @see {@link module:iterutil/async/every.every} for the asynchronous version.
+ * @see {@link module:iterutil/some.some} to test if any element satisfies the testing function.
  *
  * @example
  * ```ts