@syzlm/function 1.0.0 → 1.0.2

package/docs/functions/isPlainObject.md

@@ -0,0 +1,27 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / isPlainObject
+
+# Function: isPlainObject()
+
+> **isPlainObject**(`value`): `value is object`
+
+Defined in: objects/objectUtils.ts:95
+
+检查一个值是否是普通对象
+
+## Parameters
+
+### value
+
+`any`
+
+要检查的值
+
+## Returns
+
+`value is object`
+
+如果是普通对象返回true，否则返回false

package/docs/functions/merge.md

@@ -0,0 +1,39 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / merge
+
+# Function: merge()
+
+> **merge**\<`T`\>(`target`, ...`sources`): `T`
+
+Defined in: objects/objectUtils.ts:38
+
+对象合并函数
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### target
+
+`T`
+
+目标对象
+
+### sources
+
+...`any`[]
+
+源对象列表
+
+## Returns
+
+`T`
+
+合并后的对象

package/docs/functions/parseQrcode.md

@@ -0,0 +1,63 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / parseQrcode
+
+# Function: parseQrcode()
+
+> **parseQrcode**(`str`): \{ `invoiceCode`: `string`; `invoiceNumber`: `string`; `invoiceDate`: `string`; `optionField`: `string`; `taxFreeAmount`: `string`; \} \| `null`
+
+Defined in: business/parseQrcode.ts:22
+
+## Parameters
+
+### str
+
+`string`
+
+二维码字符串
+
+## Returns
+
+\{ `invoiceCode`: `string`; `invoiceNumber`: `string`; `invoiceDate`: `string`; `optionField`: `string`; `taxFreeAmount`: `string`; \}
+
+### invoiceCode
+
+> **invoiceCode**: `string`
+
+发票代码
+
+### invoiceNumber
+
+> **invoiceNumber**: `string`
+
+发票号码
+
+### invoiceDate
+
+> **invoiceDate**: `string`
+
+开票日期
+
+### optionField
+
+> **optionField**: `string`
+
+校验码
+
+### taxFreeAmount
+
+> **taxFreeAmount**: `string`
+
+不含税金额
+
+`null`
+
+解析后的 发票代码、发票号码、开票日期、校验码、不含税金额
+
+## Description
+
+税局生成的PDF/OFD版式文件中，左上角二维码扫描之后是一串有规则数字，现整理规则如下：
+
+## Example

package/docs/functions/parseStrEmpty.md

@@ -0,0 +1,27 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / parseStrEmpty
+
+# Function: parseStrEmpty()
+
+> **parseStrEmpty**(`str`): `string`
+
+Defined in: strings/stringUtils.ts:42
+
+转换字符串，undefined,null等转化为""
+
+## Parameters
+
+### str
+
+`string`
+
+需要转换的字符串
+
+## Returns
+
+`string`
+
+转换后的字符串

package/docs/functions/randomString.md

@@ -0,0 +1,27 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / randomString
+
+# Function: randomString()
+
+> **randomString**(`length`): `string`
+
+Defined in: strings/stringUtils.ts:27
+
+生成随机字符串函数
+
+## Parameters
+
+### length
+
+`number`
+
+字符串长度
+
+## Returns
+
+`string`
+
+随机字符串

package/docs/functions/range.md

@@ -0,0 +1,39 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / range
+
+# Function: range()
+
+> **range**(`start`, `end`, `step`): `number`[]
+
+Defined in: numbers/numberUtils.ts:8
+
+数字范围生成函数
+
+## Parameters
+
+### start
+
+`number`
+
+起始数字
+
+### end
+
+`number`
+
+结束数字
+
+### step
+
+`number` = `1`
+
+步长
+
+## Returns
+
+`number`[]
+
+生成的数字数组

package/docs/functions/round.md

@@ -0,0 +1,33 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / round
+
+# Function: round()
+
+> **round**(`num`, `decimals`): `number`
+
+Defined in: numbers/numberUtils.ts:22
+
+数字四舍五入函数
+
+## Parameters
+
+### num
+
+`number`
+
+需要四舍五入的数字
+
+### decimals
+
+`number` = `0`
+
+保留小数位数
+
+## Returns
+
+`number`
+
+四舍五入后的数字

package/docs/functions/set.md

@@ -0,0 +1,45 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / set
+
+# Function: set()
+
+> **set**\<`T`\>(`obj`, `path`, `value`): `T`
+
+Defined in: objects/objectUtils.ts:70
+
+设置对象属性值（支持路径访问）
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string`, `any`\>
+
+## Parameters
+
+### obj
+
+`T`
+
+目标对象
+
+### path
+
+`string`
+
+属性路径，如 'a.b.c'
+
+### value
+
+`any`
+
+要设置的值
+
+## Returns
+
+`T`
+
+设置后的对象

package/docs/functions/shuffle.md

@@ -0,0 +1,33 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / shuffle
+
+# Function: shuffle()
+
+> **shuffle**\<`T`\>(`arr`): `T`[]
+
+Defined in: arrays/arrayUtils.ts:45
+
+数组随机打乱函数
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### arr
+
+`T`[]
+
+需要打乱的数组
+
+## Returns
+
+`T`[]
+
+打乱后的新数组

package/docs/functions/simpleUnique.md

@@ -0,0 +1,40 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / simpleUnique
+
+# Function: simpleUnique()
+
+> **simpleUnique**\<`T`\>(`arr`): `T`[]
+
+Defined in: arrays/arrayUtils.ts:11
+
+简单数组去重函数
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### arr
+
+`T`[]
+
+需要去重的数组
+
+## Returns
+
+`T`[]
+
+去重后的新数组
+
+## Example
+
+``` javascript
+import {simpleUnique} from '@syzlm/function/arrays';
+console.log(simpleUnique([1,3,4,56,1,3]))
+```

package/docs/functions/thousandSign.md

@@ -0,0 +1,27 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / thousandSign
+
+# Function: thousandSign()
+
+> **thousandSign**(`num`): `string`
+
+Defined in: strings/stringUtils.ts:90
+
+千分位格式化
+
+## Parameters
+
+### num
+
+需要格式化的数字或字符串
+
+`string` | `number`
+
+## Returns
+
+`string`
+
+千分位格式化后的字符串

package/docs/functions/thousandSignZero.md

@@ -0,0 +1,33 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / thousandSignZero
+
+# Function: thousandSignZero()
+
+> **thousandSignZero**(`num`, `fixed?`): `string`
+
+Defined in: strings/stringUtils.ts:110
+
+千分位格式化 自动补零
+
+## Parameters
+
+### num
+
+需要格式化的数字或字符串
+
+`string` | `number`
+
+### fixed?
+
+`number`
+
+保留的小数位数，默认2位
+
+## Returns
+
+`string`
+
+千分位格式化后的字符串

package/docs/functions/throttle.md

@@ -0,0 +1,49 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / throttle
+
+# Function: throttle()
+
+> **throttle**\<`T`\>(`func`, `limit`): (...`args`) => `void`
+
+Defined in: utils/utilFunctions.ts:24
+
+节流函数
+
+## Type Parameters
+
+### T
+
+`T` *extends* (...`args`) => `any`
+
+## Parameters
+
+### func
+
+`T`
+
+需要节流的函数
+
+### limit
+
+`number`
+
+限制时间（毫秒）
+
+## Returns
+
+节流后的函数
+
+> (...`args`): `void`
+
+### Parameters
+
+#### args
+
+...`Parameters`\<`T`\>
+
+### Returns
+
+`void`

package/docs/functions/toCamelCase.md

@@ -0,0 +1,27 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / toCamelCase
+
+# Function: toCamelCase()
+
+> **toCamelCase**(`str`): `string`
+
+Defined in: strings/stringUtils.ts:8
+
+字符串驼峰命名转换函数
+
+## Parameters
+
+### str
+
+`string`
+
+需要转换的字符串
+
+## Returns
+
+`string`
+
+驼峰命名的字符串

package/docs/functions/toFixed.md

@@ -0,0 +1,33 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / toFixed
+
+# Function: toFixed()
+
+> **toFixed**(`num`, `digits`): `string`
+
+Defined in: numbers/numberUtils.ts:44
+
+精确的数字toFixed函数
+
+## Parameters
+
+### num
+
+`number`
+
+需要处理的数字
+
+### digits
+
+`number` = `0`
+
+保留小数位数
+
+## Returns
+
+`string`
+
+格式化后的字符串

package/docs/functions/unique.md

@@ -0,0 +1,39 @@
+[**Function - TypeScript 工具函数库 v1.0.1**](../README.md)
+
+***
+
+[Function - TypeScript 工具函数库](../README.md) / unique
+
+# Function: unique()
+
+> **unique**\<`T`\>(`arr`, `field?`): `T`[]
+
+Defined in: arrays/arrayUtils.ts:21
+
+数组去重函数
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string`, `any`\>
+
+## Parameters
+
+### arr
+
+`T`[]
+
+需要去重的数组
+
+### field?
+
+`string`
+
+对象数组去重需要传，对象数组去重对比字段
+
+## Returns
+
+`T`[]
+
+去重后的新数组

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@syzlm/function",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -11,14 +12,23 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist",
+    "docs",
+    "src"
+  ],
   "scripts": {
     "build": "rollup -c && tsc --emitDeclarationOnly",
     "watch": "rollup -c -w",
-    "docs": "typedoc",
+    "docs": "typedoc ",
     "docs:serve": "typedoc && npx serve docs",
     "docs:update": "typedoc",
     "build:with-docs": "rollup -c && tsc --emitDeclarationOnly && typedoc",
-    "test": "jest --verbose"
+    "test": "jest --verbose",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts"
   },
   "keywords": [],
   "author": "",
@@ -31,13 +41,21 @@
     "@rollup/plugin-typescript": "^12.3.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
     "jest": "^30.2.0",
+    "prettier": "^3.7.4",
     "rollup": "^2.79.2",
     "serve": "^14.2.5",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "tslib": "^2.8.1",
     "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.9.3"
-  }
+  },
+  "homepage": "https://gitee.com/unemployed-company/function/tree/master/docs"
 }

package/src/arrays/arrayUtils.ts

@@ -1,12 +1,42 @@
 /**
- * 数组去重函数
+ * 简单数组去重函数
  * @param arr 需要去重的数组
  * @returns 去重后的新数组
+ * @example
+ * ``` javascript
+ * import {simpleUnique} from '@syzlm/function/arrays';
+ * console.log(simpleUnique([1,3,4,56,1,3]))
+ * ```
  */
-export function unique<T>(arr: T[]): T[] {
+export function simpleUnique<T>(arr: T[]): T[] {
   return [...new Set(arr)];
 }
 
+/**
+ * 数组去重函数
+ * @param arr 需要去重的数组
+ * @param field 对象数组去重需要传，对象数组去重对比字段
+ * @returns 去重后的新数组
+ */
+export function unique<T extends Record<string, any>>(
+  arr: T[],
+  field?: string
+): T[] {
+  if (field && arr?.length) {
+    const map = new Map();
+    return arr.reduce<T[]>((res, cur) => {
+      const uniqueKey = field ? cur[field] : JSON.stringify(cur);
+      if (!map.has(uniqueKey)) {
+        map.set(uniqueKey, true);
+        res.push(cur);
+      }
+      return res;
+    }, []);
+  } else {
+    return [...new Set(arr)];
+  }
+}
+
 /**
  * 数组随机打乱函数
  * @param arr 需要打乱的数组
@@ -33,4 +63,4 @@ export function chunk<T>(arr: T[], size: number): T[][] {
     result.push(arr.slice(i, i + size));
   }
   return result;
-}
+}

package/src/arrays/index.ts

@@ -1,2 +1,2 @@
 // 数组工具函数目录入口
-export * from './arrayUtils';
+export * from './arrayUtils';