utiljs-box 1.0.0

package/README.md

@@ -0,0 +1,210 @@
+# utiljs-box
+
+一个轻量级的 TypeScript 工具函数库，提供常用的实用工具，让开发更高效。
+
+## 特性
+
+- ✅ TypeScript 编写，完整的类型定义
+- ✅ 支持 ESM 和 CommonJS 双格式
+- ✅ 按需加载，减小打包体积
+- ✅ 100% 测试覆盖率
+- ✅ 简洁易用的 API
+- ✅ 支持浏览器和 Node.js 环境
+
+## 安装
+
+```bash
+# 使用 yarn
+yarn add utiljs-box
+
+# 使用 npm
+npm install utiljs-box
+
+# 使用 pnpm
+pnpm add utiljs-box
+```
+
+## 使用
+
+```javascript
+// ESM
+import { tryJosn, sleep, removeNull } from 'utiljs-box'
+
+// CommonJS
+const { tryJosn, sleep, removeNull } = require('utiljs-box')
+```
+
+## API 文档
+
+### 1. tryJosn
+
+安全解析 JSON 字符串，避免解析失败抛出异常。
+
+**类型**：
+```typescript
+<T>(str: string, defaultValue?: T): T | null
+```
+
+**参数**：
+- `str`：要解析的 JSON 字符串
+- `defaultValue`：解析失败时返回的默认值，默认为 `null`
+
+**返回值**：
+- 解析成功返回解析后的对象
+- 解析失败返回默认值
+
+**示例**：
+```javascript
+const { tryJosn } = require('utiljs-box')
+
+const jsonStr = '{"name": "张三", "age": 18}'
+const invalidJson = '{"name": "张三", "age": 18,'
+
+console.log(tryJosn(jsonStr)) // { name: '张三', age: 18 }
+console.log(tryJosn(invalidJson)) // null
+console.log(tryJosn(invalidJson, { name: '默认名称' })) // { name: '默认名称' }
+```
+
+### 2. sleep
+
+异步延迟函数，返回一个 Promise，用于在异步函数中等待指定时间。
+
+**类型**：
+```typescript
+(ms: number): Promise<void>
+```
+
+**参数**：
+- `ms`：延迟的毫秒数
+
+**返回值**：
+- Promise 对象
+
+**示例**：
+```javascript
+const { sleep } = require('utiljs-box')
+
+async function demo() {
+  console.log('开始执行')
+  await sleep(1000) // 延迟 1 秒
+  console.log('1 秒后执行')
+  await sleep(2000) // 延迟 2 秒
+  console.log('总共延迟 3 秒')
+}
+
+demo()
+```
+
+### 3. removeNull
+
+移除对象中所有值为 `null` 的属性，支持嵌套对象。
+
+**注意**：数组中的 `null` 值不会被移除。
+
+**类型**：
+```typescript
+(obj: any): any
+```
+
+**参数**：
+- `obj`：要处理的对象
+
+**返回值**：
+- 移除 `null` 值后的新对象
+
+**示例**：
+```javascript
+const { removeNull } = require('utiljs-box')
+
+const data = {
+  name: '张三',
+  age: 18,
+  address: null,
+  contacts: {
+    phone: '13800138000',
+    email: null,
+    wechat: 'zhangsan'
+  },
+  hobbies: ['篮球', null, '游泳', null, '编程'] // 数组中的 null 不会被移除
+}
+
+console.log(removeNull(data))
+// {
+//   name: '张三',
+//   age: 18,
+//   contacts: {
+//     phone: '13800138000',
+//     wechat: 'zhangsan'
+//   },
+//   hobbies: ['篮球', null, '游泳', null, '编程']
+// }
+```
+
+## 示例
+
+查看 `examples` 目录下的示例文件：
+
+```bash
+# 运行 JavaScript 示例
+node examples/main.js
+
+# 运行 TypeScript 示例
+# 先安装 ts-node
+# npm install -g ts-node
+# ts-node examples/main.ts
+```
+
+## 开发
+
+### 安装依赖
+
+```bash
+yarn install
+```
+
+### 运行测试
+
+```bash
+yarn test
+```
+
+### 构建
+
+```bash
+yarn build
+```
+
+### 开发模式
+
+```bash
+yarn dev
+```
+
+## 测试覆盖率
+
+```
+-------------------|---------|----------|---------|---------|-------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+-------------------|---------|----------|---------|---------|-------------------
+All files          |     100 |    93.75 |     100 |     100 | 
+ sleep.ts          |     100 |      100 |     100 |     100 | 
+ tryJson.ts        |     100 |      100 |     100 |     100 | 
+ removeNull.ts     |     100 |    91.66 |     100 |     100 | 18
+-------------------|---------|----------|---------|---------|-------------------
+```
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 作者
+
+hyc
+
+## 仓库地址
+
+https://github.com/hyc8801/utilbox

package/dist/index.d.mts

@@ -0,0 +1,23 @@
+/**
+ * 尝试解析 JSON 字符串
+ * @param str 要解析的 JSON 字符串
+ * @param defaultValue 如果解析失败，返回的默认值
+ * @returns 解析后的对象或默认值
+ */
+declare const tryJosn: <T = any>(str: string, defaultValue?: T) => T | null;
+
+/**
+ * 延迟指定毫秒数的异步函数
+ * @param ms 延迟的毫秒数
+ * @returns Promise<void>
+ */
+declare const sleep: (ms: number) => Promise<void>;
+
+/**
+ * 移除对象中所有值为 null 的属性
+ * @param obj 要处理的对象
+ * @returns 移除 null 值后的新对象
+ */
+declare const removeNull: <T = any>(obj: T) => T;
+
+export { removeNull, sleep, tryJosn };

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 尝试解析 JSON 字符串
+ * @param str 要解析的 JSON 字符串
+ * @param defaultValue 如果解析失败，返回的默认值
+ * @returns 解析后的对象或默认值
+ */
+declare const tryJosn: <T = any>(str: string, defaultValue?: T) => T | null;
+
+/**
+ * 延迟指定毫秒数的异步函数
+ * @param ms 延迟的毫秒数
+ * @returns Promise<void>
+ */
+declare const sleep: (ms: number) => Promise<void>;
+
+/**
+ * 移除对象中所有值为 null 的属性
+ * @param obj 要处理的对象
+ * @returns 移除 null 值后的新对象
+ */
+declare const removeNull: <T = any>(obj: T) => T;
+
+export { removeNull, sleep, tryJosn };

package/dist/index.js

@@ -0,0 +1,84 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  removeNull: () => removeNull,
+  sleep: () => sleep,
+  tryJosn: () => tryJosn
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils/tryJson.ts
+var tryJosn = (str, defaultValue) => {
+  try {
+    return JSON.parse(str);
+  } catch (error) {
+    return defaultValue != null ? defaultValue : null;
+  }
+};
+
+// src/utils/sleep.ts
+var sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+// src/utils/removeNull.ts
+var removeNull = (obj) => {
+  if (typeof obj !== "object" || obj === null) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj;
+  }
+  const result = __spreadValues({}, obj);
+  for (const key in result) {
+    if (result.hasOwnProperty(key)) {
+      const value = result[key];
+      if (value === null) {
+        delete result[key];
+      } else if (typeof value === "object") {
+        result[key] = removeNull(value);
+      }
+    }
+  }
+  return result;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  removeNull,
+  sleep,
+  tryJosn
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/utils/tryJson.ts","../src/utils/sleep.ts","../src/utils/removeNull.ts"],"sourcesContent":["export { tryJosn } from './utils/tryJson'\nexport { sleep } from './utils/sleep'\nexport { removeNull } from './utils/removeNull'","/**\r\n * 尝试解析 JSON 字符串\r\n * @param str 要解析的 JSON 字符串\r\n * @param defaultValue 如果解析失败，返回的默认值\r\n * @returns 解析后的对象或默认值\r\n */\r\nexport const tryJosn = <T = any>(str: string, defaultValue?: T ): T | null => {\r\n  try {\r\n    return JSON.parse(str)\r\n  } catch (error) {\r\n    return defaultValue ?? null\r\n  }\r\n}\r\n\r\n\r\nexport default tryJosn\r\n","/**\n * 延迟指定毫秒数的异步函数\n * @param ms 延迟的毫秒数\n * @returns Promise<void>\n */\nexport const sleep = (ms: number): Promise<void> => {\n  return new Promise(resolve => setTimeout(resolve, ms))\n}\n\nexport default sleep","/**\n * 移除对象中所有值为 null 的属性\n * @param obj 要处理的对象\n * @returns 移除 null 值后的新对象\n */\nexport const removeNull = <T = any>(obj: T): T => {\n  if (typeof obj !== 'object' || obj === null) {\n    return obj\n  }\n\n  if (Array.isArray(obj)) {\n    return obj\n  }\n\n  const result = { ...obj }\n\n  for (const key in result) {\n    if (result.hasOwnProperty(key)) {\n      const value = result[key]\n      \n      if (value === null) {\n        delete result[key]\n      } else if (typeof value === 'object') {\n        result[key] = removeNull(value)\n      }\n    }\n  }\n\n  return result\n}\n\nexport default removeNull"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMO,IAAM,UAAU,CAAU,KAAa,iBAAgC;AAC5E,MAAI;AACF,WAAO,KAAK,MAAM,GAAG;AAAA,EACvB,SAAS,OAAO;AACd,WAAO,sCAAgB;AAAA,EACzB;AACF;;;ACPO,IAAM,QAAQ,CAAC,OAA8B;AAClD,SAAO,IAAI,QAAQ,aAAW,WAAW,SAAS,EAAE,CAAC;AACvD;;;ACFO,IAAM,aAAa,CAAU,QAAc;AAChD,MAAI,OAAO,QAAQ,YAAY,QAAQ,MAAM;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,mBAAK;AAEpB,aAAW,OAAO,QAAQ;AACxB,QAAI,OAAO,eAAe,GAAG,GAAG;AAC9B,YAAM,QAAQ,OAAO,GAAG;AAExB,UAAI,UAAU,MAAM;AAClB,eAAO,OAAO,GAAG;AAAA,MACnB,WAAW,OAAO,UAAU,UAAU;AACpC,eAAO,GAAG,IAAI,WAAW,KAAK;AAAA,MAChC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,58 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+
+// src/utils/tryJson.ts
+var tryJosn = (str, defaultValue) => {
+  try {
+    return JSON.parse(str);
+  } catch (error) {
+    return defaultValue != null ? defaultValue : null;
+  }
+};
+
+// src/utils/sleep.ts
+var sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+// src/utils/removeNull.ts
+var removeNull = (obj) => {
+  if (typeof obj !== "object" || obj === null) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj;
+  }
+  const result = __spreadValues({}, obj);
+  for (const key in result) {
+    if (result.hasOwnProperty(key)) {
+      const value = result[key];
+      if (value === null) {
+        delete result[key];
+      } else if (typeof value === "object") {
+        result[key] = removeNull(value);
+      }
+    }
+  }
+  return result;
+};
+export {
+  removeNull,
+  sleep,
+  tryJosn
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/tryJson.ts","../src/utils/sleep.ts","../src/utils/removeNull.ts"],"sourcesContent":["/**\r\n * 尝试解析 JSON 字符串\r\n * @param str 要解析的 JSON 字符串\r\n * @param defaultValue 如果解析失败，返回的默认值\r\n * @returns 解析后的对象或默认值\r\n */\r\nexport const tryJosn = <T = any>(str: string, defaultValue?: T ): T | null => {\r\n  try {\r\n    return JSON.parse(str)\r\n  } catch (error) {\r\n    return defaultValue ?? null\r\n  }\r\n}\r\n\r\n\r\nexport default tryJosn\r\n","/**\n * 延迟指定毫秒数的异步函数\n * @param ms 延迟的毫秒数\n * @returns Promise<void>\n */\nexport const sleep = (ms: number): Promise<void> => {\n  return new Promise(resolve => setTimeout(resolve, ms))\n}\n\nexport default sleep","/**\n * 移除对象中所有值为 null 的属性\n * @param obj 要处理的对象\n * @returns 移除 null 值后的新对象\n */\nexport const removeNull = <T = any>(obj: T): T => {\n  if (typeof obj !== 'object' || obj === null) {\n    return obj\n  }\n\n  if (Array.isArray(obj)) {\n    return obj\n  }\n\n  const result = { ...obj }\n\n  for (const key in result) {\n    if (result.hasOwnProperty(key)) {\n      const value = result[key]\n      \n      if (value === null) {\n        delete result[key]\n      } else if (typeof value === 'object') {\n        result[key] = removeNull(value)\n      }\n    }\n  }\n\n  return result\n}\n\nexport default removeNull"],"mappings":";;;;;;;;;;;;;;;;;;AAMO,IAAM,UAAU,CAAU,KAAa,iBAAgC;AAC5E,MAAI;AACF,WAAO,KAAK,MAAM,GAAG;AAAA,EACvB,SAAS,OAAO;AACd,WAAO,sCAAgB;AAAA,EACzB;AACF;;;ACPO,IAAM,QAAQ,CAAC,OAA8B;AAClD,SAAO,IAAI,QAAQ,aAAW,WAAW,SAAS,EAAE,CAAC;AACvD;;;ACFO,IAAM,aAAa,CAAU,QAAc;AAChD,MAAI,OAAO,QAAQ,YAAY,QAAQ,MAAM;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,mBAAK;AAEpB,aAAW,OAAO,QAAQ;AACxB,QAAI,OAAO,eAAe,GAAG,GAAG;AAC9B,YAAM,QAAQ,OAAO,GAAG;AAExB,UAAI,UAAU,MAAM;AAClB,eAAO,OAAO,GAAG;AAAA,MACnB,WAAW,OAAO,UAAU,UAAU;AACpC,eAAO,GAAG,IAAI,WAAW,KAAK;AAAA,MAChC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "utiljs-box",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "jest",
+    "prepublishOnly": "yarn build"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "typescript",
+    "utils",
+    "tryJson",
+    "sleep",
+    "removeNull"
+  ],
+  "author": "hyc8868",
+  "license": "MIT",
+  "description": "A collection of TypeScript utility functions",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hyc8801/utilbox.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hyc8801/utilbox/issues"
+  },
+  "homepage": "https://github.com/hyc8801/utilbox#readme",
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^30.2.0",
+    "prettier": "^3.8.0",
+    "ts-jest": "^29.4.6",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}