min-heap-typed 1.39.1 → 1.39.3

package/dist/data-structures/queue/deque.d.ts

@@ -37,25 +37,25 @@ export declare class ObjectDeque<E = number> {
      */
     addLast(value: E): void;
     /**
-     * The function `pollFirst()` removes and returns the first element in a data structure.
+     * The function `popFirst()` removes and returns the first element in a data structure.
      * @returns The value of the first element in the data structure.
      */
-    pollFirst(): E | undefined;
+    popFirst(): E | undefined;
     /**
-     * The `peekFirst` function returns the first element in an array-like data structure if it exists.
+     * The `getFirst` function returns the first element in an array-like data structure if it exists.
      * @returns The element at the first position of the `_nodes` array.
      */
-    peekFirst(): E | undefined;
+    getFirst(): E | undefined;
     /**
-     * The `pollLast()` function removes and returns the last element in a data structure.
+     * The `popLast()` function removes and returns the last element in a data structure.
      * @returns The value that was removed from the data structure.
      */
-    pollLast(): E | undefined;
+    popLast(): E | undefined;
     /**
-     * The `peekLast()` function returns the last element in an array-like data structure.
+     * The `getLast()` function returns the last element in an array-like data structure.
      * @returns The last element in the array "_nodes" is being returned.
      */
-    peekLast(): E | undefined;
+    getLast(): E | undefined;
     /**
      * The get function returns the element at the specified index in an array-like data structure.
      * @param {number} index - The index parameter is a number that represents the position of the element you want to
@@ -87,16 +87,16 @@ export declare class ArrayDeque<E> {
      */
     addLast(value: E): number;
     /**
-     * The function "pollLast" returns and removes the last element from an array, or returns null if the array is empty.
-     * @returns The method `pollLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
+     * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
-    pollLast(): E | null;
+    popLast(): E | null;
     /**
-     * The `pollFirst` function removes and returns the first element from an array, or returns null if the array is empty.
-     * @returns The `pollFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
+     * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
+     * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
      * empty.
      */
-    pollFirst(): E | null;
+    popFirst(): E | null;
     /**
      * O(n) time complexity of adding at the beginning and the end
      */
@@ -108,16 +108,16 @@ export declare class ArrayDeque<E> {
      */
     addFirst(value: E): number;
     /**
-     * The `peekFirst` function returns the first element of an array or null if the array is empty.
-     * @returns The function `peekFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
+     * The `getFirst` function returns the first element of an array or null if the array is empty.
+     * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
      * empty, it will return `null`.
      */
-    peekFirst(): E | null;
+    getFirst(): E | null;
     /**
-     * The `peekLast` function returns the last element of an array or null if the array is empty.
-     * @returns The method `peekLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     * The `getLast` function returns the last element of an array or null if the array is empty.
+     * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
-    peekLast(): E | null;
+    getLast(): E | null;
     /**
      * O(1) time complexity of obtaining the value
      */

package/dist/data-structures/queue/deque.js

@@ -85,44 +85,44 @@ class ObjectDeque {
         this._size++;
     }
     /**
-     * The function `pollFirst()` removes and returns the first element in a data structure.
+     * The function `popFirst()` removes and returns the first element in a data structure.
      * @returns The value of the first element in the data structure.
      */
-    pollFirst() {
+    popFirst() {
         if (!this._size)
             return;
-        const value = this.peekFirst();
+        const value = this.getFirst();
         delete this._nodes[this._first];
         this._first++;
         this._size--;
         return value;
     }
     /**
-     * The `peekFirst` function returns the first element in an array-like data structure if it exists.
+     * The `getFirst` function returns the first element in an array-like data structure if it exists.
      * @returns The element at the first position of the `_nodes` array.
      */
-    peekFirst() {
+    getFirst() {
         if (this._size)
             return this._nodes[this._first];
     }
     /**
-     * The `pollLast()` function removes and returns the last element in a data structure.
+     * The `popLast()` function removes and returns the last element in a data structure.
      * @returns The value that was removed from the data structure.
      */
-    pollLast() {
+    popLast() {
         if (!this._size)
             return;
-        const value = this.peekLast();
+        const value = this.getLast();
         delete this._nodes[this._last];
         this._last--;
         this._size--;
         return value;
     }
     /**
-     * The `peekLast()` function returns the last element in an array-like data structure.
+     * The `getLast()` function returns the last element in an array-like data structure.
      * @returns The last element in the array "_nodes" is being returned.
      */
-    peekLast() {
+    getLast() {
         if (this._size)
             return this._nodes[this._last];
     }
@@ -172,19 +172,19 @@ class ArrayDeque {
         return this._nodes.push(value);
     }
     /**
-     * The function "pollLast" returns and removes the last element from an array, or returns null if the array is empty.
-     * @returns The method `pollLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
+     * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
-    pollLast() {
+    popLast() {
         var _a;
         return (_a = this._nodes.pop()) !== null && _a !== void 0 ? _a : null;
     }
     /**
-     * The `pollFirst` function removes and returns the first element from an array, or returns null if the array is empty.
-     * @returns The `pollFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
+     * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
+     * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
      * empty.
      */
-    pollFirst() {
+    popFirst() {
         var _a;
         return (_a = this._nodes.shift()) !== null && _a !== void 0 ? _a : null;
     }
@@ -201,19 +201,19 @@ class ArrayDeque {
         return this._nodes.unshift(value);
     }
     /**
-     * The `peekFirst` function returns the first element of an array or null if the array is empty.
-     * @returns The function `peekFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
+     * The `getFirst` function returns the first element of an array or null if the array is empty.
+     * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
      * empty, it will return `null`.
      */
-    peekFirst() {
+    getFirst() {
         var _a;
         return (_a = this._nodes[0]) !== null && _a !== void 0 ? _a : null;
     }
     /**
-     * The `peekLast` function returns the last element of an array or null if the array is empty.
-     * @returns The method `peekLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     * The `getLast` function returns the last element of an array or null if the array is empty.
+     * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
-    peekLast() {
+    getLast() {
         var _a;
         return (_a = this._nodes[this._nodes.length - 1]) !== null && _a !== void 0 ? _a : null;
     }

package/dist/data-structures/queue/queue.d.ts

@@ -68,11 +68,11 @@ export declare class Queue<E = any> {
      */
     peek(): E | undefined;
     /**
-     * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
-     * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+     * The `getLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+     * @returns The method `getLast()` returns the last element of the `_nodes` array if the array is not empty. If the
      * array is empty, it returns `null`.
      */
-    peekLast(): E | undefined;
+    getLast(): E | undefined;
     /**
      * The enqueue function adds a value to the end of a queue.
      * @param {E} value - The value parameter represents the value that you want to add to the queue.

package/dist/data-structures/queue/queue.js

@@ -109,11 +109,11 @@ class Queue {
         return this.size > 0 ? this.nodes[this.offset] : undefined;
     }
     /**
-     * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
-     * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+     * The `getLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+     * @returns The method `getLast()` returns the last element of the `_nodes` array if the array is not empty. If the
      * array is empty, it returns `null`.
      */
-    peekLast() {
+    getLast() {
         return this.size > 0 ? this.nodes[this.nodes.length - 1] : undefined;
     }
     /**

package/dist/interfaces/binary-tree.d.ts

@@ -1,7 +1,7 @@
 import { BinaryTreeNode } from '../data-structures';
-import { BinaryTreeDeletedResult, BinaryTreeNodeKey, BinaryTreeNodeNested, OneParamCallback } from '../types';
+import { BinaryTreeDeletedResult, BTNKey, BinaryTreeNodeNested, BTNCallback } from '../types';
 export interface IBinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNodeNested<V>> {
-    createNode(key: BinaryTreeNodeKey, val?: N['val']): N;
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: N['val']): N | null | undefined;
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
+    createNode(key: BTNKey, val?: N['val']): N;
+    add(keyOrNode: BTNKey | N | null, val?: N['val']): N | null | undefined;
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
 }

package/dist/types/data-structures/binary-tree/binary-tree.d.ts

@@ -18,7 +18,7 @@ export declare enum FamilyPosition {
     ISOLATED = "ISOLATED",
     MAL_NODE = "MAL_NODE"
 }
-export type BinaryTreeNodeKey = number;
+export type BTNKey = number;
 export type BinaryTreeDeletedResult<N> = {
     deleted: N | null | undefined;
     needBalanced: N | null;

package/dist/types/data-structures/binary-tree/bst.d.ts

@@ -1,6 +1,6 @@
 import { BSTNode } from '../../../data-structures';
-import type { BinaryTreeNodeKey, BinaryTreeOptions } from './binary-tree';
-export type BSTComparator = (a: BinaryTreeNodeKey, b: BinaryTreeNodeKey) => number;
+import type { BTNKey, BinaryTreeOptions } from './binary-tree';
+export type BSTComparator = (a: BTNKey, b: BTNKey) => number;
 export type BSTNodeNested<T> = BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
 export type BSTOptions = BinaryTreeOptions & {
     comparator?: BSTComparator;

package/dist/types/helpers.d.ts

@@ -1,6 +1,6 @@
 export type Comparator<T> = (a: T, b: T) => number;
 export type DFSOrderPattern = 'pre' | 'in' | 'post';
-export type OneParamCallback<N, D = any> = (node: N) => D;
+export type BTNCallback<N, D = any> = (node: N) => D;
 export declare enum CP {
     lt = "lt",
     eq = "eq",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "min-heap-typed",
-  "version": "1.39.1",
+  "version": "1.39.3",
   "description": "Min Heap. Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
@@ -131,6 +131,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.39.0"
+    "data-structure-typed": "^1.39.2"
   }
 }

package/src/data-structures/binary-tree/avl-tree.ts

@@ -6,14 +6,14 @@
  * @license MIT License
  */
 import {BST, BSTNode} from './bst';
-import type {AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BinaryTreeNodeKey} from '../../types';
-import {OneParamCallback} from '../../types';
+import type {AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BTNKey} from '../../types';
+import {BTNCallback} from '../../types';
 import {IBinaryTree} from '../../interfaces';
 
 export class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNested<V>> extends BSTNode<V, N> {
   height: number;
 
-  constructor(key: BinaryTreeNodeKey, val?: V) {
+  constructor(key: BTNKey, val?: V) {
     super(key, val);
     this.height = 0;
   }
@@ -35,27 +35,27 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
 
   /**
    * The function creates a new AVL tree node with the specified key and value.
-   * @param {BinaryTreeNodeKey} key - The key parameter is the key value that will be associated with
+   * @param {BTNKey} key - The key parameter is the key value that will be associated with
    * the new node. It is used to determine the position of the node in the binary search tree.
    * @param [val] - The parameter `val` is an optional value that can be assigned to the node. It is of
    * type `V`, which means it can be any value that is assignable to the `val` property of the
    * node type `N`.
    * @returns a new AVLTreeNode object with the specified key and value.
    */
-  override createNode(key: BinaryTreeNodeKey, val?: V): N {
+  override createNode(key: BTNKey, val?: V): N {
     return new AVLTreeNode<V, N>(key, val) as N;
   }
 
   /**
    * The function overrides the add method of a binary tree node and balances the tree after inserting
    * a new node.
-   * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
-   * `BinaryTreeNodeKey` or a `N` (which represents a node in the binary tree) or `null`.
+   * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
+   * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
    * @param [val] - The `val` parameter is the value that you want to assign to the new node that you
    * are adding to the binary search tree.
    * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
    */
-  override add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V): N | null | undefined {
+  override add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined {
     // TODO support node as a param
     const inserted = super.add(keyOrNode, val);
     if (inserted) this._balancePath(inserted);
@@ -66,7 +66,7 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * The function overrides the delete method of a binary tree and balances the tree after deleting a
    * node if necessary.
    * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-   * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+   * `BTNKey` or a generic type `N`. It represents the property of the node that we are
    * searching for. It can be a specific key value or any other property of the node.
    * @param callback - The `callback` parameter is a function that takes a node as input and returns a
    * value. This value is compared with the `identifier` parameter to determine if the node should be
@@ -74,7 +74,7 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * `this._defaultCallbackByKey`
    * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
    */
-  override delete<C extends OneParamCallback<N>>(
+  override delete<C extends BTNCallback<N>>(
     identifier: ReturnType<C>,
     callback: C = this._defaultCallbackByKey as C
   ): BinaryTreeDeletedResult<N>[] {