heap-typed 2.4.4 → 2.5.0

package/README.md

@@ -34,111 +34,6 @@ yarn add heap-typed
 
 [//]: # (No deletion!!! Start of Example Replace Section)
 
-### basic Heap creation and add operation
-```typescript
- // Create a min heap (default)
-    const minHeap = new Heap([5, 3, 7, 1, 9, 2]);
-
-    // Verify size
-    console.log(minHeap.size); // 6;
-
-    // Add new element
-    minHeap.add(4);
-    console.log(minHeap.size); // 7;
-
-    // Min heap property: smallest element at root
-    const min = minHeap.peek();
-    console.log(min); // 1;
-```
-
-### Heap with custom comparator (MaxHeap behavior)
-```typescript
- interface Task {
-      id: number;
-      priority: number;
-      name: string;
-    }
-
-    // Custom comparator for max heap behavior (higher priority first)
-    const tasks: Task[] = [
-      { id: 1, priority: 5, name: 'Email' },
-      { id: 2, priority: 3, name: 'Chat' },
-      { id: 3, priority: 8, name: 'Alert' }
-    ];
-
-    const maxHeap = new Heap(tasks, {
-      comparator: (a: Task, b: Task) => b.priority - a.priority
-    });
-
-    console.log(maxHeap.size); // 3;
-
-    // Peek returns highest priority task
-    const topTask = maxHeap.peek();
-    console.log(topTask?.priority); // 8;
-    console.log(topTask?.name); // 'Alert';
-```
-
-### Heap for event processing with priority
-```typescript
- interface Event {
-      id: number;
-      type: 'critical' | 'warning' | 'info';
-      timestamp: number;
-      message: string;
-    }
-
-    // Custom priority: critical > warning > info
-    const priorityMap = { critical: 3, warning: 2, info: 1 };
-
-    const eventHeap = new Heap<Event>([], {
-      comparator: (a: Event, b: Event) => {
-        const priorityA = priorityMap[a.type];
-        const priorityB = priorityMap[b.type];
-        return priorityB - priorityA; // Higher priority first
-      }
-    });
-
-    // Add events in random order
-    eventHeap.add({ id: 1, type: 'info', timestamp: 100, message: 'User logged in' });
-    eventHeap.add({ id: 2, type: 'critical', timestamp: 101, message: 'Server down' });
-    eventHeap.add({ id: 3, type: 'warning', timestamp: 102, message: 'High memory' });
-    eventHeap.add({ id: 4, type: 'info', timestamp: 103, message: 'Cache cleared' });
-    eventHeap.add({ id: 5, type: 'critical', timestamp: 104, message: 'Database error' });
-
-    console.log(eventHeap.size); // 5;
-
-    // Process events by priority (critical first)
-    const processedOrder: Event[] = [];
-    while (eventHeap.size > 0) {
-      const event = eventHeap.poll();
-      if (event) {
-        processedOrder.push(event);
-      }
-    }
-
-    // Verify critical events came first
-    console.log(processedOrder[0].type); // 'critical';
-    console.log(processedOrder[1].type); // 'critical';
-    console.log(processedOrder[2].type); // 'warning';
-    console.log(processedOrder[3].type); // 'info';
-    console.log(processedOrder[4].type); // 'info';
-
-    // Verify O(log n) operations
-    const newHeap = new Heap<number>([5, 3, 7, 1]);
-
-    // Add - O(log n)
-    newHeap.add(2);
-    console.log(newHeap.size); // 5;
-
-    // Poll - O(log n)
-    const removed = newHeap.poll();
-    console.log(removed); // 1;
-
-    // Peek - O(1)
-    const top = newHeap.peek();
-    console.log(top); // 2;
-```
-
 ### Use Heap to solve top k problems
 ```typescript
  function topKElements(arr: number[], k: number): number[] {
@@ -262,6 +157,14 @@ yarn add heap-typed
     console.log(scheduleTasks(tasks, 2)); // expectedMap;
 ```
 
+### Get all elements as array
+```typescript
+ const heap = new Heap<number>([5, 1, 3, 2, 4]);
+    const arr = heap.toArray();
+    console.log(arr.length); // 5;
+    console.log(arr.sort()); // [1, 2, 3, 4, 5];
+```
+
 [//]: # (No deletion!!! End of Example Replace Section)