@domain.js/main 0.1.0 → 0.1.1

package/dist/utils/index.js

@@ -7,7 +7,11 @@ const RAND_STR_DICT = {
     normal: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
     strong: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%&’()*+,-./:;<=>?@[]^_`{|}~",
 };
-/** 计算给定字符串的md5值 */
+/**
+ * Calculates the MD5 value of the given string
+ * @param str string or An object that contains a toString method that returns a string
+ * @returns hex md5 string
+ */
 const md5 = (str) => {
     const hash = crypto.createHash("md5");
     return hash.update(str.toString()).digest().toString("hex");
@@ -25,19 +29,43 @@ function randStr(len, type) {
         .join("");
 }
 exports.randStr = randStr;
-/** 将字符串里的换行，制表符替换为普通空格 */
+/**
+ * Replace line breaks and tabs in the string with ordinary spaces
+ * @param value string that will be replaced
+ * @returns has been replaced string
+ */
 const nt2space = (value) => value.replace(/(\\[ntrfv]|\s)+/g, " ").trim();
 exports.nt2space = nt2space;
-/** 首字符大写 */
+/**
+ * The first character of the string is capitalized
+ * @param value string
+ * @returns string
+ * @example ufrist("hello"); // Return a string is: "Hello"
+ * @see lcfirst
+ */
 const ucfirst = (value) => value[0].toUpperCase() + value.substring(1);
 exports.ucfirst = ucfirst;
-/** 首字符小写 */
+/**
+ * The first character of the string is lowercase
+ * @param value string
+ * @returns string
+ * @example ufrist("Hello"); // Return a string is: "hello"
+ * @see ucfirst
+ */
 const lcfirst = (value) => value[0].toLowerCase() + value.substring(1);
 exports.lcfirst = lcfirst;
-/** 睡眠等待 */
+/**
+ * Pause, waiting
+ * @param ms The time you want to wait, in milliseconds
+ * @returns None
+ */
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 exports.sleep = sleep;
-/** 深度冻结一个对象，防止被不小心篡改 */
+/**
+ * Freeze a object and deepth
+ * @param object The object that will be freezed
+ * @returns freezed object
+ */
 const deepFreeze = (object) => {
     // Retrieve the property names defined on object
     const propNames = Object.getOwnPropertyNames(object);
@@ -50,24 +78,42 @@ const deepFreeze = (object) => {
     return Object.freeze(object);
 };
 exports.deepFreeze = deepFreeze;
-const tryCatchLog = (fn, errorLog) => async (...args) => {
-    try {
-        await fn(...args);
-    }
-    catch (e) {
-        errorLog(e);
-    }
+/**
+ * Mask exceptions of functions
+ * @param fn The function will be mask exceptions
+ * @param errorLog Error handle function, when has happed throw exception
+ * @returns Wrapped function
+ */
+const tryCatchLog = (fn, errorLog) => {
+    const wrapped = async (...args) => {
+        try {
+            await fn(...args);
+        }
+        catch (e) {
+            errorLog(e);
+        }
+    };
+    return wrapped;
 };
 exports.tryCatchLog = tryCatchLog;
 /**
- 判断某个秒级时间戳是否已过期，基于当前时间
+ * Determine whether a second timestamp has expired
+ * @param time timestamp
+ * @param life Effective time, seconds
+ * @returns true or false
  */
 const inExpired = (time, life) => {
     const now = (Date.now() / 1000) | 0;
     return time < now - life;
 };
 exports.inExpired = inExpired;
-/** 修改指定url上添加一些参数 */
+/**
+ * Modify a URL address, add some attributes and delete some attributes
+ * @param address URL address
+ * @param adds The params will be expand to address
+ * @param removes The string list will be remove from address
+ * @returns Modified address
+ */
 const modifiyURL = (address, adds, removes) => {
     const obj = new URL(address);
     if (typeof adds === "object") {

package/jest.config.js

@@ -2,5 +2,12 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
-  forceExit: true,
+  // forceExit: true,
+  collectCoverageFrom: [
+    "src/utils/*.ts",
+    "src/deps/**/*.ts",
+    "src/dm/index.ts",
+    "src/http/**/*.ts",
+    "src/cli/*.ts",
+  ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domain.js/main",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "DDD framework",
   "main": "dist/index.js",
   "scripts": {
@@ -15,16 +15,6 @@
   "author": "Redstone Zhao",
   "license": "MIT",
   "devDependencies": {
-    "@types/async": "^3.2.10",
-    "@types/crypto-js": "^4.0.2",
-    "@types/ioredis": "^4.28.1",
-    "@types/jest": "^27.0.3",
-    "@types/lodash": "^4.14.177",
-    "@types/lru-cache": "^5.1.1",
-    "@types/restify": "^8.5.4",
-    "@types/restify-errors": "^4.3.4",
-    "@types/uuid": "^8.3.3",
-    "@types/validator": "^13.7.0",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",
     "babel-eslint": "^10.1.0",
@@ -42,6 +32,7 @@
     "prettier": "^2.3.0",
     "sequelize-json-schema": "^2.1.1",
     "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
     "typescript": "^4.5.2"
   },
   "prettier": {
@@ -55,6 +46,16 @@
     ]
   },
   "dependencies": {
+    "@types/async": "^3.2.10",
+    "@types/crypto-js": "^4.0.2",
+    "@types/ioredis": "^4.28.1",
+    "@types/jest": "^27.0.3",
+    "@types/lodash": "^4.14.177",
+    "@types/lru-cache": "^5.1.1",
+    "@types/restify": "^8.5.4",
+    "@types/restify-errors": "^4.3.4",
+    "@types/uuid": "^8.3.3",
+    "@types/validator": "^13.7.0",
     "ajv": "^8.8.1",
     "ajv-formats": "^2.1.1",
     "async": "^3.2.2",
@@ -72,7 +73,7 @@
     "restify-errors": "^8.0.2",
     "sequelize": "^6.9.0",
     "swagger-ui-restify": "^3.0.8",
-    "ts-node": "^10.4.0",
+    "type-fest": "^2.8.0",
     "uuid": "^8.3.2",
     "xlsx": "^0.17.4"
   }