docs: add more tsdoc comments

packages/assert/src/asserts/arrayContains.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that an array contains an item.
+ * @param array - The array to check.
+ * @param item - The item to check for.
+ * @param message - Optional message to display on failure.
+ */
 export function arrayContains<T>(
   array: T[],
   item: T,

packages/assert/src/asserts/arrayNotEmpty.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that an array is not empty.
+ * @param array - The array to check.
+ * @param message - Optional message to display on failure.
+ */
 export function arrayNotEmpty<T>(
   array: T[],
   message: string = "Array is empty",

packages/assert/src/asserts/equals.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that two values are equal.
+ * @param actual - The actual value.
+ * @param expected - The expected value.
+ * @param message - Optional message to display on failure.
+ */
 export function equals<T>(
   actual: T,
   expected: T,

packages/assert/src/asserts/greaterThan.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a number is greater than another number.
+ * @param actual - The actual number.
+ * @param expected - The expected number.
+ * @param message - Optional message to display on failure.
+ */
 export function greaterThan(
   actual: number,
   expected: number,

packages/assert/src/asserts/instanceOf.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that an object is an instance of the specified class.
+ * @param object - The object to check.
+ * @param constructor - The class to check for.
+ * @param message - Optional message to display on failure.
+ */
 export function instanceOf<T>(
   object: unknown,
   constructor: { new (...args: unknown[]): T },

packages/assert/src/asserts/isBoolean.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a value is a boolean.
+ * @param value - The value to check.
+ * @param message - Optional message to display on failure.
+ */
 export function isBoolean(
   value: unknown,
   message: string = "Value is not a boolean",

packages/assert/src/asserts/isDefined.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a value is defined.
+ * @param value - The value to check.
+ * @param message - Optional message to display on failure.
+ */
 export function isDefined<T>(
   value: T | undefined,
   message: string = "Value should be defined",

packages/assert/src/asserts/isNotNull.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a value is not null.
+ * @param value - The value to check.
+ * @param message - Optional message to display on failure.
+ */
 export function isNotNull<T>(
   value: T | null,
   message: string = "Value should not be null",

packages/assert/src/asserts/isNumber.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a value is a number.
+ * @param value - The value to check.
+ * @param message - Optional message to display on failure.
+ */
 export function isNumber(
   value: unknown,
   message: string = "Value is not a number",

packages/assert/src/asserts/isString.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a value is a string.
+ * @param value - The value to check.
+ * @param message - Optional message to display on failure.
+ */
 export function isString(
   value: unknown,
   message: string = "Value is not a string",

packages/assert/src/asserts/lessThan.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a number is less than another number.
+ * @param actual - The actual number.
+ * @param expected - The expected number.
+ * @param message - Optional message to display on failure.
+ */
 export function lessThan(
   actual: number,
   expected: number,

packages/assert/src/asserts/notEquals.assert.ts

@@ -1,5 +1,11 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that two values are not equal.
+ * @param actual - The actual value.
+ * @param expected - The expected value.
+ * @param message - Optional message to display on failure.
+ */
 export function notEquals<T>(
   actual: T,
   expected: T,

packages/assert/src/asserts/throws.assert.ts

@@ -1,5 +1,10 @@
 import { assert } from "../utils/assert.util.js";
 
+/**
+ * Asserts that a function throws an error.
+ * @param block - The function to execute.
+ * @param message - Optional message to display on failure.
+ */
 export function throws(
   block: () => void,
   message: string = "Expected function to throw an error",

packages/assert/src/errors/AssertionError.error.ts

@@ -1,4 +1,12 @@
+/**
+ * AssertionError
+ * @param {string} message
+ * @returns {AssertionError}
+ */
 export class AssertionError extends Error {
+  /**
+   * @param {string} message
+   */
   constructor(message: string) {
     super(message);
     this.name = "AssertionError";

packages/assert/src/utils/assert.util.ts

@@ -1,5 +1,10 @@
 import { AssertionError } from "../errors/AssertionError.error.js";
 
+/**
+ * Asserts that a condition is true.
+ * @param condition - The condition to check.
+ * @param message - Optional message to display on failure.
+ */
 export function assert(
   condition: boolean,
   message: string = "Assertion failed",

packages/better-map/src/index.ts

@@ -1,9 +1,28 @@
+
+/**
+ * A better Map class that has some more useful methods.
+ *
+ * @template k The type of the keys.
+ * @template v The type of the values.
+ */
 export class BetterMap<k, v> extends Map<k, v> {
+
+  /**
+   * Updates a value in the map if it exists, otherwise sets it to the default value.
+   * @param key - The key of the value to update.
+   * @param updater - The function to update the value with.
+   * @param notset - The default value to set if the key does not exist.
+   */
   update(key: k, updater: (v: v, k: k) => v, notset?: v) {
     if (this.has(key)) this.set(key, updater(this.get(key)!, key));
     else this.set(key, notset ?? updater(this.get(key)!, key));
   }
 
+  /**
+   * Filters the map by a predicate.
+   * @param predicate - The predicate to filter by.
+   * @returns A new map with the filtered values.
+   */
   filter(predicate: (v: v, k: k) => boolean) {
     const newMap = new BetterMap<k, v>();
     const entries = Array.from(this.entries());
@@ -13,6 +32,11 @@ export class BetterMap<k, v> extends Map<k, v> {
     return newMap;
   }
 
+  /**
+   * Maps the map by a predicate.
+   * @param predicate - The predicate to map by.
+   * @returns A new map with the mapped values.
+   */
   merge(map: Map<k, v>, resolve: (k: k, a: v, b: v) => v = (k, a, b) => b) {
     const entries = Array.from(map.entries());
     for (const [key, value] of entries) {

packages/better-set/src/index.ts

@@ -1,4 +1,15 @@
+
+/**
+ * A better Set class with more methods.
+ * @template v The type of the values.
+ */
 export class BetterSet<v> extends Set<v> {
+
+  /**
+   * Filters the set by a predicate.
+   * @param predicate - The predicate to filter by.
+   * @returns A new set with the filtered values.
+   */
   filter(predicate: (v: v) => boolean) {
     const newSet = new BetterSet<v>();
     const entries = Array.from(this.entries());
@@ -8,13 +19,25 @@ export class BetterSet<v> extends Set<v> {
     return newSet;
   }
 
+  /**
+   * Maps the set by a predicate.
+   * @param predicate - The predicate to map by.
+   * @returns A new set with the mapped values.
+   * @template v2 The type of the mapped values.
+   */
   merge(set: Set<v>) {
     const entries = Array.from(set.entries());
     for (const kv of entries) {
       this.add(kv[0]);
     }
   }
 
+  /**
+   * Maps the set by a predicate.
+   * @param predicate - The predicate to map by.
+   * @returns A new set with the mapped values.
+   * @template v2 The type of the mapped values.
+   */
   except(set: Set<v>) {
     const newSet = new Set<v>();
     const entries = Array.from(set.entries());
@@ -24,6 +47,12 @@ export class BetterSet<v> extends Set<v> {
     return newSet;
   }
 
+  /**
+   * Maps the set by a predicate.
+   * @param predicate - The predicate to map by.
+   * @returns A new set with the mapped values.
+   * @template v2 The type of the mapped values.
+   */
   both(set: Set<v>) {
     const newSet = new Set<v>();
     const entries = Array.from(set.entries());