ts-data-forge 1.0.0 → 1.0.2

package/dist/collections/stack.mjs

@@ -0,0 +1,353 @@
+import { Arr } from '../array/array-utils.mjs';
+import '../array/tuple-utils.mjs';
+import { Optional } from '../functional/optional.mjs';
+import '../functional/result.mjs';
+import '../number/branded-types/finite-number.mjs';
+import '../number/branded-types/int.mjs';
+import '../number/branded-types/int16.mjs';
+import '../number/branded-types/int32.mjs';
+import '../number/branded-types/non-negative-finite-number.mjs';
+import '../number/branded-types/non-negative-int16.mjs';
+import '../number/branded-types/non-negative-int32.mjs';
+import '../number/branded-types/non-zero-finite-number.mjs';
+import '../number/branded-types/non-zero-int.mjs';
+import '../number/branded-types/non-zero-int16.mjs';
+import '../number/branded-types/non-zero-int32.mjs';
+import '../number/branded-types/non-zero-safe-int.mjs';
+import '../number/branded-types/non-zero-uint16.mjs';
+import '../number/branded-types/non-zero-uint32.mjs';
+import '../number/branded-types/positive-finite-number.mjs';
+import '../number/branded-types/positive-int.mjs';
+import '../number/branded-types/positive-int16.mjs';
+import '../number/branded-types/positive-int32.mjs';
+import '../number/branded-types/positive-safe-int.mjs';
+import '../number/branded-types/positive-uint16.mjs';
+import '../number/branded-types/positive-uint32.mjs';
+import '../number/branded-types/safe-int.mjs';
+import '../number/branded-types/safe-uint.mjs';
+import '../number/branded-types/uint.mjs';
+import '../number/branded-types/uint16.mjs';
+import { asUint32 } from '../number/branded-types/uint32.mjs';
+import '../number/enum/int8.mjs';
+import '../number/enum/uint8.mjs';
+import '../number/num.mjs';
+import '../number/refined-number-utils.mjs';
+import { castMutable } from '../others/cast-mutable.mjs';
+
+/**
+ * Class implementation for a stack with LIFO (Last-In, First-Out) behavior using a dynamic array.
+ * This implementation provides O(1) amortized push and O(1) pop operations by using a resizable buffer
+ * that grows as needed.
+ *
+ * The underlying array automatically resizes when it becomes full, ensuring that the stack
+ * can grow to accommodate any number of elements while maintaining efficient operations.
+ *
+ * @template T The type of elements in the stack.
+ * @implements Stack
+ */
+class StackClass {
+    /** @internal Dynamic array to store stack elements. */
+    #buffer;
+    /** @internal Current number of elements in the stack. */
+    #mut_size;
+    /** @internal Current capacity of the buffer. */
+    #capacity;
+    /** @internal Initial capacity for new stacks. */
+    static #INITIAL_CAPACITY = 8;
+    /**
+     * Constructs a new StackClass instance.
+     * @param initialValues Optional initial values to populate the stack.
+     */
+    constructor(initialValues = []) {
+        const initialCapacity = asUint32(Math.max(StackClass.#INITIAL_CAPACITY, initialValues.length * 2));
+        this.#buffer = castMutable(Arr.create(initialCapacity, undefined));
+        this.#mut_size = 0;
+        this.#capacity = initialCapacity;
+        // Add initial values
+        for (const value of initialValues) {
+            this.push(value);
+        }
+    }
+    /** @inheritdoc */
+    get isEmpty() {
+        return this.#mut_size === 0;
+    }
+    /** @inheritdoc */
+    get size() {
+        return asUint32(this.#mut_size);
+    }
+    /**
+     * Removes and returns the element at the top of the stack (LIFO).
+     *
+     * This operation removes the element that was added most recently (last-in) and returns it.
+     * If the stack is empty, returns `Optional.none`. The operation is guaranteed to be O(1)
+     * and does not require any array resizing or memory reallocation.
+     *
+     * **Time Complexity:** O(1) - constant time operation
+     * **Space Complexity:** O(1) - no additional memory allocation
+     *
+     * @returns An Optional containing the removed element, or `Optional.none` if the stack is empty.
+     *
+     * @example
+     * ```typescript
+     * const stack = createStack<string>();
+     *
+     * // Add some elements
+     * stack.push("bottom");
+     * stack.push("middle");
+     * stack.push("top");
+     *
+     * // Remove elements in LIFO order
+     * const top = stack.pop();
+     * if (top.isSome) {
+     *   console.log(top.value); // "top" (last pushed, first popped)
+     * }
+     *
+     * const middle = stack.pop().unwrap(); // "middle"
+     * console.log(stack.size); // 1
+     *
+     * // Safe handling of empty stack
+     * const emptyStack = createStack<number>();
+     * const result = emptyStack.pop();
+     * if (result.isNone) {
+     *   console.log("Stack is empty");
+     * }
+     *
+     * // Typical usage in algorithms
+     * const pathStack = createStack<string>();
+     * pathStack.push("/home");
+     * pathStack.push("/users");
+     * pathStack.push("/documents");
+     *
+     * // Backtrack one level
+     * const currentDir = pathStack.pop().unwrap(); // "/documents"
+     * const parentDir = pathStack.pop().unwrap();  // "/users"
+     * ```
+     */
+    pop() {
+        if (this.isEmpty) {
+            return Optional.none;
+        }
+        this.#mut_size -= 1;
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const element = this.#buffer[this.#mut_size];
+        this.#buffer[this.#mut_size] = undefined; // Clear reference for garbage collection
+        return Optional.some(element);
+    }
+    /**
+     * Adds an element to the top of the stack (LIFO).
+     *
+     * This operation adds the element to the top of the stack, where it will be the first
+     * to be popped (last-in, first-out ordering). The operation is amortized O(1),
+     * meaning it's O(1) for most operations with occasional O(n) when the buffer needs resizing.
+     *
+     * **Time Complexity:** O(1) amortized - O(n) only when buffer resize is needed
+     * **Space Complexity:** O(1) - constant additional memory per element
+     *
+     * **Buffer Resizing:** When the internal buffer becomes full, it automatically doubles
+     * in size and copies existing elements to maintain the stack structure.
+     *
+     * @param value The element to add to the top of the stack.
+     *
+     * @example
+     * ```typescript
+     * const actionStack = createStack<string>();
+     *
+     * // Add actions in chronological order
+     * actionStack.push("open file");        // O(1)
+     * actionStack.push("edit content");     // O(1)
+     * actionStack.push("save file");        // O(1)
+     *
+     * console.log(actionStack.size); // 3
+     *
+     * // Actions will be undone in reverse order (LIFO)
+     * while (!actionStack.isEmpty) {
+     *   const action = actionStack.pop().unwrap();
+     *   console.log(`Undoing: ${action}`);
+     * }
+     * // Output:
+     * // Undoing: save file
+     * // Undoing: edit content
+     * // Undoing: open file
+     *
+     * // High-volume pushing (demonstrates amortized O(1) performance)
+     * const dataStack = createStack<number>();
+     *
+     * for (let i = 0; i < 1000000; i++) {
+     *   dataStack.push(i); // Each operation is O(1) amortized
+     * }
+     *
+     * console.log(dataStack.size); // 1000000
+     *
+     * // Function call stack simulation
+     * type StackFrame = { function: string; variables: Record<string, any> };
+     * const callStack = createStack<StackFrame>();
+     *
+     * callStack.push({ function: "main", variables: { argc: 1, argv: ["program"] } });
+     * callStack.push({ function: "process", variables: { data: [1, 2, 3] } });
+     * callStack.push({ function: "validate", variables: { input: "test" } });
+     *
+     * // Current function context is at the top
+     * const currentFrame = callStack.pop().unwrap();
+     * console.log(`Current function: ${currentFrame.function}`);
+     * ```
+     */
+    push(value) {
+        // Resize if buffer is full
+        if (this.#mut_size === this.#capacity) {
+            this.#resize();
+        }
+        this.#buffer[this.#mut_size] = value;
+        this.#mut_size += 1;
+    }
+    /**
+     * @internal
+     * Resizes the buffer when it becomes full.
+     * Doubles the capacity while preserving all elements.
+     */
+    #resize() {
+        const newCapacity = asUint32(this.#capacity * 2);
+        const newBuffer = castMutable(Arr.create(newCapacity, undefined));
+        // Copy existing elements
+        for (let i = 0; i < this.#mut_size; i++) {
+            newBuffer[i] = this.#buffer[i];
+        }
+        this.#buffer = newBuffer;
+        this.#capacity = newCapacity;
+    }
+}
+/**
+ * Creates a new Stack instance with LIFO (Last-In, First-Out) behavior using a high-performance dynamic array.
+ *
+ * This factory function creates an optimized stack implementation that maintains excellent performance
+ * characteristics for both push and pop operations. The underlying dynamic array automatically
+ * resizes to accommodate growing workloads while providing predictable O(1) operations.
+ *
+ * **Implementation Features:**
+ * - **O(1) push operations** (amortized - occasionally O(n) when resizing)
+ * - **O(1) pop operations** (always)
+ * - **Automatic buffer resizing** - starts at 8 elements, doubles when full
+ * - **Memory efficient** - garbage collects removed elements immediately
+ * - **Dynamic array design** - eliminates need for complex memory management
+ *
+ * **Performance Benefits:**
+ * - No array shifting required for stack operations
+ * - Minimal memory allocation overhead
+ * - Predictable performance under high load
+ * - Efficient memory usage with automatic cleanup
+ *
+ * @template T The type of elements stored in the stack.
+ * @param initialValues Optional array of initial elements to populate the stack.
+ *                      Elements will be popped in reverse order of how they appear in the array
+ *                      (last array element will be popped first).
+ *                      If provided, the initial buffer capacity will be at least twice the array length.
+ * @returns A new Stack instance optimized for high-performance LIFO operations.
+ *
+ * @example
+ * ```typescript
+ * import { createStack } from './stack';
+ *
+ * // Example 1: Function call simulation
+ * type FunctionCall = { name: string; args: any[]; context: any };
+ * const callStack = createStack<FunctionCall>();
+ *
+ * // Simulate function calls (push onto stack)
+ * callStack.push({ name: "main", args: [], context: {} });              // O(1)
+ * callStack.push({ name: "processData", args: [data], context: {} });   // O(1)
+ * callStack.push({ name: "validateInput", args: [input], context: {} }); // O(1)
+ *
+ * // Simulate function returns (pop from stack)
+ * while (!callStack.isEmpty) {
+ *   const call = callStack.pop().unwrap(); // O(1)
+ *   console.log(`Returning from: ${call.name}`);
+ * }
+ * // Output:
+ * // Returning from: validateInput
+ * // Returning from: processData
+ * // Returning from: main
+ *
+ * // Example 2: Expression evaluation with operator precedence
+ * const operatorStack = createStack<string>();
+ * const operandStack = createStack<number>();
+ *
+ * // Simulate parsing "3 + 4 * 2"
+ * operandStack.push(3);
+ * operatorStack.push("+");
+ * operandStack.push(4);
+ * operatorStack.push("*");  // Higher precedence
+ * operandStack.push(2);
+ *
+ * // Process higher precedence first (LIFO)
+ * const op = operatorStack.pop().unwrap(); // "*"
+ * const b = operandStack.pop().unwrap();   // 2
+ * const a = operandStack.pop().unwrap();   // 4
+ * operandStack.push(a * b); // Push result: 8
+ *
+ * // Example 3: Undo/Redo functionality
+ * type EditAction = {
+ *   type: 'insert' | 'delete' | 'modify';
+ *   position: number;
+ *   oldValue: string;
+ *   newValue: string;
+ * };
+ *
+ * const undoStack = createStack<EditAction>();
+ * const redoStack = createStack<EditAction>();
+ *
+ * // Perform edits (push to undo stack)
+ * const edit1: EditAction = { type: 'insert', position: 0, oldValue: '', newValue: 'Hello' };
+ * const edit2: EditAction = { type: 'insert', position: 5, oldValue: '', newValue: ' World' };
+ *
+ * undoStack.push(edit1);
+ * undoStack.push(edit2);
+ *
+ * // Undo last edit
+ * if (!undoStack.isEmpty) {
+ *   const lastEdit = undoStack.pop().unwrap();
+ *   redoStack.push(lastEdit);
+ *   console.log(`Undid: ${lastEdit.type} at position ${lastEdit.position}`);
+ * }
+ *
+ * // Example 4: High-throughput data processing
+ * const processingStack = createStack<number>();
+ *
+ * // Add large amount of data (demonstrates amortized O(1) performance)
+ * for (let i = 0; i < 100000; i++) {
+ *   processingStack.push(i); // Each push is O(1) amortized
+ * }
+ *
+ * // Process data in LIFO order
+ * let processedCount = 0;
+ * while (!processingStack.isEmpty) {
+ *   const value = processingStack.pop().unwrap(); // O(1)
+ *   // Process value...
+ *   processedCount++;
+ * }
+ * console.log(`Processed ${processedCount} items`); // 100000
+ *
+ * // Example 5: Stack with pre-populated data
+ * const historyStack = createStack<string>([
+ *   "page1.html",
+ *   "page2.html",
+ *   "page3.html",
+ *   "page4.html"
+ * ]);
+ *
+ * console.log(historyStack.size); // Output: 4
+ *
+ * // Navigate back through history (LIFO order)
+ * while (!historyStack.isEmpty) {
+ *   const page = historyStack.pop().unwrap();
+ *   console.log(`Going back to: ${page}`);
+ * }
+ * // Output:
+ * // Going back to: page4.html (last added, first removed)
+ * // Going back to: page3.html
+ * // Going back to: page2.html
+ * // Going back to: page1.html
+ * ```
+ */
+const createStack = (initialValues) => new StackClass(initialValues);
+
+export { createStack };
+//# sourceMappingURL=stack.mjs.map

package/dist/collections/stack.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack.mjs","sources":["../../src/collections/stack.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqFA;;;;;;;;;;AAUG;AACH,MAAM,UAAU,CAAA;;AAEd,IAAA,OAAO;;AAGP,IAAA,SAAS;;AAGT,IAAA,SAAS;;AAGT,IAAA,OAAgB,iBAAiB,GAAG,CAAC;AAErC;;;AAGG;AACH,IAAA,WAAA,CAAY,gBAA8B,EAAE,EAAA;AAC1C,QAAA,MAAM,eAAe,GAAG,QAAQ,CAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CACjE;AAED,QAAA,IAAI,CAAC,OAAO,GAAG,WAAW,CACxB,GAAG,CAAC,MAAM,CAAgB,eAAe,EAAE,SAAS,CAAC,CACtD;AACD,QAAA,IAAI,CAAC,SAAS,GAAG,CAAC;AAClB,QAAA,IAAI,CAAC,SAAS,GAAG,eAAe;;AAGhC,QAAA,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE;AACjC,YAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;;;;AAKpB,IAAA,IAAI,OAAO,GAAA;AACT,QAAA,OAAO,IAAI,CAAC,SAAS,KAAK,CAAC;;;AAI7B,IAAA,IAAI,IAAI,GAAA;AACN,QAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;;AAGjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CG;IACH,GAAG,GAAA;AACD,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,QAAQ,CAAC,IAAI;;AAGtB,QAAA,IAAI,CAAC,SAAS,IAAI,CAAC;;QAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAE;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAEzC,QAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;;AAG/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDG;AACH,IAAA,IAAI,CAAC,KAAQ,EAAA;;QAEX,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YACrC,IAAI,CAAC,OAAO,EAAE;;QAGhB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK;AACpC,QAAA,IAAI,CAAC,SAAS,IAAI,CAAC;;AAGrB;;;;AAIG;IACH,OAAO,GAAA;QACL,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;AAChD,QAAA,MAAM,SAAS,GAAG,WAAW,CAC3B,GAAG,CAAC,MAAM,CAAgB,WAAW,EAAE,SAAS,CAAC,CAClD;;AAGD,QAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;YACvC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;;AAGhC,QAAA,IAAI,CAAC,OAAO,GAAG,SAAS;AACxB,QAAA,IAAI,CAAC,SAAS,GAAG,WAAW;;;AAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkIG;AACI,MAAM,WAAW,GAAG,CAAK,aAA4B,KAC1D,IAAI,UAAU,CAAI,aAAa;;;;"}

package/dist/expect-type.d.mts

@@ -0,0 +1,199 @@
+/**
+ * Compile-time type assertion utility for TypeScript type testing.
+ *
+ * This function performs static type relationship checking at compile-time and has no runtime effect.
+ * It is primarily used in test files to verify that TypeScript's type inference and type relationships
+ * work as expected. The function will cause TypeScript compilation errors if the specified type
+ * relationship does not hold.
+ *
+ * ## Supported Type Relations
+ *
+ * ### Equality Relations
+ * - **`"="` (strict equality)**: Asserts that types `A` and `B` are exactly the same type.
+ *   Uses TypeScript's internal type equality checking.
+ * - **`"!="` (strict inequality)**: Asserts that types `A` and `B` are not exactly the same type.
+ *
+ * ### Assignability Relations
+ * - **`"~="` (mutual assignability)**: Asserts that `A` extends `B` AND `B` extends `A`.
+ *   Types are structurally equivalent and mutually assignable.
+ * - **`"<="` (subtype relation)**: Asserts that type `A` extends (is assignable to) type `B`.
+ *   Type `A` is a subtype of `B`.
+ * - **`">="` (supertype relation)**: Asserts that type `B` extends (is assignable to) type `A`.
+ *   Type `A` is a supertype of `B`.
+ *
+ * ### Negative Assignability Relations
+ * - **`"!<="` (not subtype)**: Asserts that type `A` does NOT extend type `B`.
+ * - **`"!>="` (not supertype)**: Asserts that type `B` does NOT extend type `A`.
+ *
+ * ## Type Parameter Constraints
+ *
+ * @template A - The first type for comparison. Can be any TypeScript type including:
+ *   - Primitive types (string, number, boolean, etc.)
+ *   - Object types and interfaces
+ *   - Union and intersection types
+ *   - Generic types and type parameters
+ *   - Literal types and branded types
+ *   - Function types and return types
+ * @template B - The second type for comparison. Same constraints as type `A`.
+ *
+ * @param _relation - A string literal representing the expected type relationship.
+ *   TypeScript's type system automatically infers and restricts the available operators
+ *   based on the actual relationship between types `A` and `B`. If an invalid relationship
+ *   is specified, TypeScript will show a compilation error.
+ *
+ * ## Usage Patterns
+ *
+ * ### Basic Type Testing
+ * @example
+ * ```typescript
+ * import { expectType } from './expect-type.mjs';
+ *
+ * // Primitive type equality
+ * expectType<string, string>("=");           // ✓ exact match
+ * expectType<number, string>("!=");          // ✓ different types
+ * expectType<42, number>("<=");              // ✓ literal extends primitive
+ * expectType<number, 42>(">=");              // ✓ primitive is supertype
+ *
+ * // Type assertions will cause compilation errors for wrong relationships:
+ * // expectType<string, number>("=");        // ❌ TypeScript error
+ * // expectType<number, string>("<=");       // ❌ TypeScript error
+ * ```
+ *
+ * ### Array and Tuple Type Validation
+ * @example
+ * ```typescript
+ * // Testing array utility function return types
+ * const zeros = Arr.zeros(3);
+ * expectType<typeof zeros, readonly [0, 0, 0]>("=");
+ *
+ * const sequence = Arr.seq(5);
+ * expectType<typeof sequence, readonly [0, 1, 2, 3, 4]>("=");
+ *
+ * // Dynamic length arrays
+ * const dynamicArray = Arr.zeros(someLength);
+ * expectType<typeof dynamicArray, readonly 0[]>("=");
+ * ```
+ *
+ * ### Function Return Type Testing
+ * @example
+ * ```typescript
+ * // Testing function return types
+ * const createUser = () => ({ id: 1, name: 'John' });
+ * expectType<ReturnType<typeof createUser>, { id: number; name: string }>("~=");
+ *
+ * // Generic function type inference
+ * const identity = <T>(x: T): T => x;
+ * const result = identity('hello');
+ * expectType<typeof result, string>("=");
+ * ```
+ *
+ * ### Union and Intersection Types
+ * @example
+ * ```typescript
+ * // Union type relationships
+ * expectType<string, string | number>("<=");     // string extends union
+ * expectType<string | number, string>(">=");     // union contains string
+ * expectType<string | number, number>(">=");     // union contains number
+ *
+ * // Intersection type relationships
+ * type A = { a: number };
+ * type B = { b: string };
+ * expectType<A & B, A>(">=");                    // intersection extends component
+ * expectType<A, A & B>("<=");                    // component extends intersection
+ * ```
+ *
+ * ### Branded Type Validation
+ * @example
+ * ```typescript
+ * // Testing branded number types
+ * expectType<PositiveInt, number>("<=");         // branded type extends base
+ * expectType<number, PositiveInt>(">=");         // base type is supertype
+ * expectType<PositiveInt, NegativeInt>("!=");    // different branded types
+ *
+ * // Type guard function validation
+ * if (isPositiveInt(value)) {
+ *   expectType<typeof value, PositiveInt>("<=");
+ * }
+ * ```
+ *
+ * ### Optional and Result Type Testing
+ * @example
+ * ```typescript
+ * // Optional type narrowing
+ * const optional: Optional<number> = Optional.some(42);
+ * if (Optional.isSome(optional)) {
+ *   expectType<typeof optional, Optional.Some<number>>("<=");
+ * }
+ * if (Optional.isNone(optional)) {
+ *   expectType<typeof optional, Optional.None>("<=");
+ * }
+ *
+ * // Result type validation
+ * const result: Result<string, Error> = Result.ok('success');
+ * expectType<typeof result, Result<string, Error>>("<=");
+ * ```
+ *
+ * ### Type Guard and Validation Testing
+ * @example
+ * ```typescript
+ * // Testing type guard functions
+ * if (isRecord(value)) {
+ *   expectType<typeof value, UnknownRecord>("<=");
+ * }
+ *
+ * // Testing compile-time type predicates
+ * const obj = { key: 'value' };
+ * if (hasKey(obj, 'key')) {
+ *   expectType<typeof obj.key, unknown>("<=");
+ * }
+ * ```
+ *
+ * ## Common Testing Patterns
+ *
+ * ### Dual Testing Strategy
+ * Combine `expectType` with runtime assertions for comprehensive testing:
+ *
+ * @example
+ * ```typescript
+ * describe('Arr.zeros', () => {
+ *   test('should create array of zeros with correct type', () => {
+ *     const result = Arr.zeros(3);
+ *
+ *     // Compile-time type assertion
+ *     expectType<typeof result, readonly [0, 0, 0]>("=");
+ *
+ *     // Runtime behavior assertion
+ *     expect(result).toStrictEqual([0, 0, 0]);
+ *   });
+ * });
+ * ```
+ *
+ * ### Type Relationship Validation
+ * Test complex type hierarchies and relationships:
+ *
+ * @example
+ * ```typescript
+ * // Ensure proper type hierarchy
+ * expectType<PositiveInt, Int>("<=");           // positive is subset of int
+ * expectType<Int, FiniteNumber>("<=");          // int is subset of finite
+ * expectType<FiniteNumber, number>("<=");       // finite is subset of number
+ *
+ * // Verify mutual exclusion
+ * expectType<PositiveInt, NegativeInt>("!=");   // different int types
+ * expectType<PositiveInt, NegativeInt>("!<=");  // neither extends the other
+ * expectType<NegativeInt, PositiveInt>("!<=");
+ * ```
+ *
+ * ## Important Notes
+ *
+ * - **Compile-time only**: This function has no runtime behavior and will be optimized away.
+ * - **Type inference**: The available relation operators are automatically inferred by TypeScript
+ *   based on the actual type relationship between `A` and `B`.
+ * - **Error feedback**: Invalid type relationships will cause clear TypeScript compilation errors.
+ * - **Test organization**: Typically used in `.test.mts` files alongside runtime assertions.
+ * - **Performance**: Has zero runtime overhead as it's purely a compile-time construct.
+ *
+ * @since 1.0.0
+ */
+export declare const expectType: <A, B>(_relation: TypeEq<A, B> extends true ? "<=" | "=" | ">=" | "~=" : "!=" | (TypeExtends<A, B> extends true ? "<=" | (TypeExtends<B, A> extends true ? ">=" | "~=" : "!>=") : "!<=" | (TypeExtends<B, A> extends true ? ">=" : "!>="))) => void;
+//# sourceMappingURL=expect-type.d.mts.map

package/dist/expect-type.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expect-type.d.mts","sourceRoot":"","sources":["../src/expect-type.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoMG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,EAC7B,WAAW,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAChC,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAEpB,IAAI,GACJ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAC3B,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC,GAC7D,KAAK,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,KACnE,IAAiB,CAAC"}