📝 add doc about limiter abort

harvey-woo · Dec 10, 2023 · b5be82a · b5be82a
1 parent ce2f9a2
commit b5be82a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -186,6 +186,9 @@ const limiter = pool.limit({
   minDuration: 1000,
 });
 
+// limiter has a `abort` method that can abort the current consumption function, the return of execution will throw an error
+limiter.abort(new DOMException('AbortError'));
+
 ```
 
 ### pLimit / Pool.limit / limit

diff --git a/README_CN.md b/README_CN.md
@@ -189,6 +189,9 @@ const limiter = pool.limit({
   minDuration: 1000,
 });
 
+// 资源限制器提供了一个 `abort` 方法，可以中断当前的消费函数，使执行返回会抛出错误
+limiter.abort(new DOMException('AbortError'));
+
 ```
 
 ### pLimit / Pool.limit