feat: 添加最大长度maxLength配置项.

PinghuaZhuang · Sep 6, 2023 · a12120e · a12120e
1 parent 529c824
commit a12120e
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -38,12 +38,8 @@ pnpm dev
 
 ~~处理程序可以是 Promise.~~
 
-+ rigister?: Record<ActionTypeEnum, handler>
-+ ~~mergeRule?: (newActions: Action[], cur: Action, curIndex, otherActions: Action[]) => Actioin[].~~
-+ ~~debounce?: 是否开启防抖模式.~~
-  + @default: true
-+ ~~merge?: 是否允许合并操作.~~
-  + @default: true
++ handlers?: Record<ActionTypeEnum, handler>
++ options?: { maxLength: number }
 
 ## Methods
 

diff --git a/example/index.ts b/example/index.ts
@@ -51,6 +51,8 @@ window.addEventListener('DOMContentLoaded', () => {
       inp.value = target!.context.oldValue;
       console.log('CHANGE undo:', inp.value, target, end);
     },
+  }, {
+    maxLength: 5,
   });
   // @ts-ignore
   window.cs = cs;

diff --git a/index.html b/index.html
@@ -27,7 +27,7 @@
   </style>
 </head>
 <body>
-  <h3>example: 文本</h3>
+  <h3>example: 文本 maxLength = 5</h3>
   <input id="inp" disabled />
   <br />
   <input id="updateInp" />

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@zstark/command-stack",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "keywords": [
     "undo-redo"

diff --git a/src/index.ts b/src/index.ts
@@ -25,13 +25,21 @@ export type StackEvent<T> = {
   end?: T;
 };
 
+export type CommandStackOption = {
+  /**
+   * 记录最大长度, 默认不限制
+   */
+  maxLength?: number;
+};
+
 export default class CommandStack<
   T extends Action<string, any>,
 > extends EventEmitter {
   static events = {
     STACK_CHANGE: 'stack.change',
   };
 
+  option!: CommandStackOption;
   private $stackIdx = -1;
   private $event: StackEvent<T> | null = null;
   _stack: T[] = [];
@@ -43,9 +51,11 @@ export default class CommandStack<
 
   constructor(
     handlers = {} as Record<T['type'], (event: StackEvent<T>) => void>,
+    option: CommandStackOption = {},
   ) {
     super();
     this._handlers = { ...handlers };
+    this.option = { ...option };
     this.rigister();
   }
 
@@ -77,9 +87,15 @@ export default class CommandStack<
 
   dispatch(action: T) {
     this._stack.splice(this._stackIdx + 1);
-    this._stack.push(action);
-    this._stackIdx++;
+    const length = this._stack.push(action);
     this.$event = null;
+    if (
+      Number.isSafeInteger(this.option.maxLength) &&
+      length > (this.option.maxLength as number)
+    ) {
+      this._stack.shift();
+    }
+    this._stackIdx = Math.min(this._stack.length - 1, this._stackIdx + 1);
   }
 
   excute(action: T) {

diff --git a/tsconfig.json b/tsconfig.json
@@ -3,7 +3,8 @@
     "target": "ES2015",
     "module": "ES2022",
     "lib": [
-      "ES2022"
+      "ES2022",
+      "DOM"
     ],
     "moduleResolution": "Bundler",
     "resolveJsonModule": true,