Function heappush

heappush<T>(heap: T[], item: T, compareFn??: ((x: any, y: any) => number)): void
Push the value item onto the heap, maintaining the heap invariant.
Type Parameters
- T
Parameters
- heap: T[]
- item: T
- Optional compareFn: ((x: any, y: any) => number) = compare
  
  Custom compare function
  - - (x: any, y: any): number
    - Checks whether x is a comparable type and returns the result of x.compare(y). Otherwise the return value of the compare function is equivalent to obj === other ? 0 : obj < other ? -1 : 1
      
      Returns
      The comparison result
      
      See
      
      Array.sort()
      
      eq
      
      lt
      
      Parameters
      
      x: any
      
      An initial value
      
      y: any
      
      Other value to compare
      
      Returns number
Returns void
- Defined in src/collections/Heap.ts:170

Generated using TypeDoc