addressable-binary-heaps/dist/@types/types.d.ts

A versatile TypeScript library for addressable binary heaps, delivering optimized and scalable min-heap and max-heap implementations, seamlessly supporting both object-oriented and functional paradigms.

/**
 * An interface representing a node in the binary heap data structure.
 * Each node must have a numeric key that determines its position in the heap.
 */
interface IHeapNode {
    /**
     * The numeric key value used for heap ordering.
     * - Lower values have higher priority in a min-heap,
     * - higher values have higher priority in a max-heap.
     */
    key: number;
}
/**
 * A specialized array type that maintains heap properties and node indices.
 * Extends the standard `Array` with a `WeakMap` to track node positions.
 *
 * @typeParam N - The type of heap node.
 */
type IHeapArray<N extends IHeapNode = IHeapNode> = Array<N> & {
    /**
     * Maps heap nodes to their current indices in the array.
     */
    indices: WeakMap<N, number>;
};

export type { IHeapArray, IHeapNode };