@domain.js/main 0.3.15 → 0.3.18

package/dist/deps/frequency/index.d.ts

@@ -9,7 +9,16 @@ interface Deps {
     redis: Pick<Redis, "hincrby" | "expire" | "hget" | "hdel">;
 }
 export declare function Main(cnf: Cnf, deps: Deps): {
-    control: (filed: string, ms: number, limit: number) => Promise<void>;
-    check: (filed: string, ms: number, limit: number) => Promise<void>;
+    control: (field: string, ms: number, limit: number, msg?: string) => Promise<number>;
+    check: (field: string, ms: number, limit: number, msg?: string) => Promise<number>;
+    incr: (field: string, ms: number) => Promise<number>;
+    generate: (field: string, ms: number, limit: number, msg?: string) => {
+        /** 全流程控制，会自动累加次数 */
+        control(): Promise<number>;
+        /** 检测是否超限 */
+        check(): Promise<number>;
+        /** 仅做累加 */
+        incr(): Promise<number>;
+    };
 };
 export {};

package/dist/deps/frequency/index.js

@@ -8,49 +8,86 @@ function Main(cnf, deps) {
     /**
      * 计算应该的key
      * @param ms 频率控制长度，单位毫秒
+     * @param now 当前时间戳 毫秒值
      */
-    const getKey = (ms) => {
-        const now = Date.now();
+    const getKey = (ms, now = Date.now()) => {
         const t = Math.floor(now / ms);
         return `${KEY}-${ms}-${t}`;
     };
     /**
      * 计算过期时间
      * @param ms 频率控制长度，单位毫秒
+     * @param now 当前时间戳 毫秒值
      */
-    const expire = (ms) => {
-        const now = Date.now();
+    const expire = (ms, now = Date.now()) => {
         const t = Math.floor(now / ms);
         return Math.floor((ms * (t + 1) - now) / 1000);
     };
     /**
      * 频次控制，超过显示过抛出异常
-     * @param filed 控频字段key
+     * @param field 控频字段key
      * @param ms 控频周期长度 毫秒
      * @param limit 控频极限次数
+     * @param msg 报错信息
      */
-    const control = async (filed, ms, limit) => {
-        const key = getKey(ms);
-        const val = await redis.hincrby(key, filed, 1);
+    const control = async (field, ms, limit, msg = "Too many requests") => {
+        const now = Date.now();
+        const key = getKey(ms, now);
+        const val = await redis.hincrby(key, field, 1);
         if (val === 1)
-            await redis.expire(key, expire(ms));
+            await redis.expire(key, expire(ms, now));
         if (val > limit)
             throw Error("Too many request");
+        return val;
     };
     /**
      * 检测频次控制，超过显示过抛出异常
      * @param filed 控频字段key
      * @param ms 控频周期长度 毫秒
      * @param limit 控频极限次数
+     * @param msg 报错信息
      */
-    const check = async (filed, ms, limit) => {
+    const check = async (field, ms, limit, msg = "Too many requests") => {
         const key = getKey(ms);
-        const val = await redis.hget(key, filed);
-        if (!val)
-            return;
-        if ((Number(val) | 0) > limit)
-            throw Error("Too many request");
+        const val = await redis.hget(key, field);
+        const value = Number(val) | 0;
+        if (value > limit)
+            throw Error(msg);
+        return value;
+    };
+    /**
+     * 控频计数+1
+     * @param filed 控频字段key
+     * @param ms 控频周期长度 毫秒
+     */
+    const incr = async (field, ms) => {
+        const key = getKey(ms);
+        const val = await redis.hincrby(key, field, 1);
+        if (val === 1)
+            await redis.expire(key, expire(ms));
+        return val;
     };
-    return { control, check };
+    /**
+     * 构造一个控频对象
+     * @param filed 控频字段key
+     * @param ms 控频周期长度 毫秒
+     * @param limit 控频极限次数
+     * @param msg 报错信息
+     */
+    const generate = (field, ms, limit, msg = "Too many requests") => ({
+        /** 全流程控制，会自动累加次数 */
+        control() {
+            return control(field, ms, limit, msg);
+        },
+        /** 检测是否超限 */
+        check() {
+            return check(field, ms, limit, msg);
+        },
+        /** 仅做累加 */
+        incr() {
+            return incr(field, ms);
+        },
+    });
+    return { control, check, incr, generate };
 }
 exports.Main = Main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domain.js/main",
-  "version": "0.3.15",
+  "version": "0.3.18",
   "description": "DDD framework",
   "main": "dist/index.js",
   "bin": {