@domain.js/main 0.3.13 → 0.3.16

package/dist/deps/defines.d.ts

@@ -3,6 +3,7 @@ import * as cache from "./cache";
 import * as checker from "./checker";
 import * as counter from "./counter";
 import * as cron from "./cron";
+import * as frequency from "./frequency";
 import * as graceful from "./graceful";
 import * as hash from "./hash";
 import * as logger from "./logger";
@@ -20,6 +21,7 @@ declare const _default: {
     checker: typeof checker;
     counter: typeof counter;
     cron: typeof cron;
+    frequency: typeof frequency;
     graceful: typeof graceful;
     hash: typeof hash;
     logger: typeof logger;

package/dist/deps/defines.js

@@ -24,6 +24,7 @@ const cache = __importStar(require("./cache"));
 const checker = __importStar(require("./checker"));
 const counter = __importStar(require("./counter"));
 const cron = __importStar(require("./cron"));
+const frequency = __importStar(require("./frequency"));
 const graceful = __importStar(require("./graceful"));
 const hash = __importStar(require("./hash"));
 const logger = __importStar(require("./logger"));
@@ -41,6 +42,7 @@ module.exports = {
     checker: checker,
     counter: counter,
     cron: cron,
+    frequency: frequency,
     graceful: graceful,
     hash: hash,
     logger: logger,

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

@@ -0,0 +1,24 @@
+import { Redis } from "ioredis";
+interface Cnf {
+    frequency: {
+        key: string;
+    };
+}
+export declare const Deps: readonly ["redis"];
+interface Deps {
+    redis: Pick<Redis, "hincrby" | "expire" | "hget" | "hdel">;
+}
+export declare function Main(cnf: Cnf, deps: Deps): {
+    control: (field: string, ms: number, limit: number) => Promise<number>;
+    check: (field: string, ms: number, limit: number) => Promise<number>;
+    incr: (field: string, ms: number) => Promise<number>;
+    generate: (field: string, ms: number, limit: number) => Promise<{
+        /** 全流程控制，会自动累加次数 */
+        control(): Promise<number>;
+        /** 检测是否超限 */
+        check(): Promise<number>;
+        /** 仅做累加 */
+        incr(): Promise<number>;
+    }>;
+};
+export {};

package/dist/deps/frequency/index.js

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

package/dist/index.d.ts

@@ -21,6 +21,7 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     checker: typeof import("./deps/checker");
     counter: typeof import("./deps/counter");
     cron: typeof import("./deps/cron");
+    frequency: typeof import("./deps/frequency");
     graceful: typeof import("./deps/graceful");
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");
@@ -32,12 +33,13 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     schema: typeof import("./deps/schema");
     sequelize: typeof import("./deps/sequelize");
     signer: typeof import("./deps/signer");
-}[Include<"schema", RemoveReadonlyArray<T>> | Include<"logger", RemoveReadonlyArray<T>> | Include<"aes", RemoveReadonlyArray<T>> | Include<"request", RemoveReadonlyArray<T>> | Include<"sequelize", RemoveReadonlyArray<T>> | Include<"cache", RemoveReadonlyArray<T>> | Include<"redis", RemoveReadonlyArray<T>> | Include<"counter", RemoveReadonlyArray<T>> | Include<"cron", RemoveReadonlyArray<T>> | Include<"myCia", RemoveReadonlyArray<T>> | Include<"hash", RemoveReadonlyArray<T>> | Include<"rest", RemoveReadonlyArray<T>> | Include<"parallel", RemoveReadonlyArray<T>> | Include<"graceful", RemoveReadonlyArray<T>> | Include<"checker", RemoveReadonlyArray<T>> | Include<"signer", RemoveReadonlyArray<T>>]["Main"] extends (arg: infer R, ...args: any[]) => any ? R : {}>) => { [k in keyof Pick<{
+}[Include<"frequency", RemoveReadonlyArray<T>> | Include<"schema", RemoveReadonlyArray<T>> | Include<"logger", RemoveReadonlyArray<T>> | Include<"aes", RemoveReadonlyArray<T>> | Include<"request", RemoveReadonlyArray<T>> | Include<"sequelize", RemoveReadonlyArray<T>> | Include<"cache", RemoveReadonlyArray<T>> | Include<"redis", RemoveReadonlyArray<T>> | Include<"counter", RemoveReadonlyArray<T>> | Include<"cron", RemoveReadonlyArray<T>> | Include<"myCia", RemoveReadonlyArray<T>> | Include<"hash", RemoveReadonlyArray<T>> | Include<"rest", RemoveReadonlyArray<T>> | Include<"parallel", RemoveReadonlyArray<T>> | Include<"graceful", RemoveReadonlyArray<T>> | Include<"checker", RemoveReadonlyArray<T>> | Include<"signer", RemoveReadonlyArray<T>>]["Main"] extends (arg: infer R, ...args: any[]) => any ? R : {}>) => { [k in keyof Pick<{
     aes: typeof import("./deps/aes");
     cache: typeof import("./deps/cache");
     checker: typeof import("./deps/checker");
     counter: typeof import("./deps/counter");
     cron: typeof import("./deps/cron");
+    frequency: typeof import("./deps/frequency");
     graceful: typeof import("./deps/graceful");
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");
@@ -55,6 +57,7 @@ export declare function Main<T extends Readonly<Array<keyof TDeps>>>(features: T
     checker: typeof import("./deps/checker");
     counter: typeof import("./deps/counter");
     cron: typeof import("./deps/cron");
+    frequency: typeof import("./deps/frequency");
     graceful: typeof import("./deps/graceful");
     hash: typeof import("./deps/hash");
     logger: typeof import("./deps/logger");

package/package.json

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