jc-structure 0.1.10 → 0.1.12

package/index.d.ts

@@ -1,26 +1,74 @@
 declare module "jc-structure" {
-  import type { IStack } from "./types/stack";
-  import type { IQueue } from "./types/queue";
-  import type { IHeap } from "./types/heap";
+  interface Structure {
+    /**
+     * 判断数据结构是否为空
+     */
+    isEmpty(): boolean;
+    /**
+     * 数据结构元素长度
+     */
+    size(): number;
+    /**
+     * 清除数据结构元素
+     */
+    clear(): void;
+    /**
+     * 重写 toString 方法
+     */
+    toString(): string;
+  }
   /**
    * 栈类，采用object实现
    */
-  interface Stack<T> extends IStack<T> {}
+  interface Stack<T> extends Structure {
+    /**
+     * #### 移除栈顶元素并返回该元素
+     */
+    pop(): T | undefined;
+
+    /**
+     * #### 向栈顶添加元素
+     * @param args 要添加的元素,key可以是多个或一个元素。
+     */
+    push(items: T | Array<T>): this;
+    push(...args: Array<T>): this;
+
+    /**
+     * #### 返回栈顶元素，但不移除
+     */
+    peek(): T | undefined;
+  }
   interface StackConstructor {
     new <T>(): Stack<T>;
     readonly prototype: Stack<T>;
   }
-  declare const Stack: StackConstructor;
+  declare var Stack: StackConstructor;
 
   /**
    * 队列类，采用object实现
    */
-  interface Queue<T> extends IQueue<T> {}
+  interface Queue<T> extends Structure {
+    /**
+     * #### 移除队列头部元素并返回该元素
+     */
+    dequeue(): T | undefined;
+
+    /**
+     * #### 向队列末尾添加元素
+     * @param args 要添加的元素
+     */
+    enqueue(items: T | Array<T>): this;
+    enqueue(...args: Array<T>): this;
+    /**
+     * #### 返回队列头部元素，但不移除
+     */
+    front(): T | undefined;
+  }
   interface QueueConstructor {
     new <T>(): Queue<T>;
     readonly prototype: Queue<T>;
   }
-  declare const Queue: QueueConstructor;
+  declare var Queue: QueueConstructor;
 
   type CompareResult = -1 | 0 | 1;
 
@@ -34,21 +82,38 @@ declare module "jc-structure" {
   /**
    * 最小堆
    */
-  interface MinHeap<T> extends IHeap<T> {}
+  interface MinHeap<T> extends Structure {
+    /**
+     * #### 插入一个值，返回一个布尔值
+     * @param value 要插入的值
+     */
+    insert(value: T): boolean;
+
+    /**
+     * #### 移除最小值或最大值，返回该值
+     */
+    extract(): T | undefined;
+
+    /**
+     * 查找一个值
+     * @param value 要查找的值
+     */
+    find(): T | undefined;
+  }
   interface MinHeapConstructor {
     new <T>(fn?: CompareFn<T>): MinHeap<T>;
     readonly prototype: MinHeap<T>;
   }
-  declare const MinHeap: MinHeapConstructor;
+  declare var MinHeap: MinHeapConstructor;
 
   /**
    * 最大堆
    */
-  interface Constructor {
+  interface MaxConstructor {
     new <T>(fn?: CompareFn<T>): MinHeap<T>;
     readonly prototype: MinHeap<T>;
   }
-  declare const MaxHeap: Constructor;
+  declare var MaxHeap: MaxConstructor;
   /**
    * LRU缓存类
    */
@@ -69,7 +134,7 @@ declare module "jc-structure" {
     new <K, V>(capacity?: number): LRU<K, V>;
     readonly prototype: LRU<K, V>;
   }
-  declare const LRU: LRUConstructor;
+  declare var LRU: LRUConstructor;
 
   /**
    * 链表节点类
@@ -269,7 +334,7 @@ declare module "jc-structure" {
      */
     toRoman(num: number): string;
   }
-  declare const Roman: RomanConstructor;
+  declare var Roman: RomanConstructor;
 
   interface Point {
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jc-structure",
   "private": false,
-  "version": "0.1.10",
+  "version": "0.1.12",
   "type": "module",
   "files": [
     "dist",

package/types/global.d.ts

@@ -1,4 +1,4 @@
-export declare interface Structure {
+interface Structure {
   /**
    * 判断数据结构是否为空
    */
@@ -19,10 +19,16 @@ export declare interface Structure {
 
 type CompareResult = -1 | 0 | 1;
 
+/**
+ * #### 比较函数接口
+ */
 interface CompareFn<T> {
   (a: T, b: T): CompareResult;
 }
 
+/**
+ * #### 对象接口，用于存储数据结构元素，值类型默认为 any
+ */
 interface Obj<V = any> {
   [key: string]: V;
 }

package/types/heap.d.ts

@@ -1,6 +1,7 @@
-// import type { Structure } from "./global";
-
-export declare interface IHeap<T> extends Structure {
+/**
+ * #### 堆
+ */
+interface IHeap<T> extends Structure {
   /**
    * #### 插入一个值，返回一个布尔值
    * @param value 要插入的值

package/types/queue.d.ts

@@ -1,7 +1,7 @@
 /**
  * #### 队列接口
  */
-export declare interface IQueue<T> extends Structure {
+interface IQueue<T> extends Structure {
   /**
    * #### 移除队列头部元素并返回该元素
    */

package/types/stack.d.ts

@@ -1,13 +1,11 @@
-import type { Structure } from "./global";
-
-export interface StructureObj<T> {
+interface StructureObj<T> {
   [key: number]: T;
 }
 
 /**
  * #### 栈接口
  */
-export declare interface IStack<T> extends Structure {
+interface IStack<T> extends Structure {
   /**
    * #### 移除栈顶元素并返回该元素
    */