jiezhangxin-utils

jiezhangxin-utils

A utility toolkit for Vue 3 projects, supporting tree-shaking and按需引入.

Installation

npm install jiezhangxin-utils
# or
yarn add jiezhangxin-utils
# or
pnpm add jiezhangxin-utils

Features

• ✅ 按需引入：支持ES模块tree-shaking
• ✅ 多种格式：CJS、ESM、UMD
• ✅ Vue 3友好：兼容Vue 3项目
• ✅ 类型安全：良好的类型提示

Usage

整体引入

import * as utils from 'jiezhangxin-utils';

// 使用工具函数
utils.formatMoney(1000);
utils.handleViewFile('https://example.com/file.pdf');

按需引入（推荐）

import { formatMoney, handleViewFile } from 'jiezhangxin-utils';

// 只引入需要的函数
formatMoney(1000);
handleViewFile('https://example.com/file.pdf');

按需引入具体模块

// 引入工具函数
import { formatMoney } from 'jiezhangxin-utils';

// 引入cookie相关函数
import { getToken, setToken } from 'jiezhangxin-utils';

// 引入常量
import { CacheKey } from 'jiezhangxin-utils';

API

工具函数

• formatAmountToUnits(amount) - 将金额格式化为单位数组
• getCurrentMonth() - 获取当前月份
• formatMoney(money, decimalPlaces) - 格式化金额，添加千分位
• handleViewFile(fileUrl) - 安全打开远程文件/PDF
• exportFile(exportLoading, exportUrl, name) - 导出文件
• postExportFile(exportLoading, exportUrl, name, params) - POST方式导出文件
• getFileTypeFromUrlRegex(url) - 从URL获取文件类型
• extractPermissions(tree, options) - 从树形菜单数据中提取所有按钮类型的权限 code，支持无限层级递归
• formatMenuData(data, isMenu = false) - 格式化菜单数据，支持无限层级递归
• formatMenuDataToTree(data) - 格式化菜单数据为树形结构（0.0.5）
• PermissionPlugin - Vue 权限插件，用于全局注册 v-permission 指令和 $hasPermission 方法（0.0.5）

Cookie相关

• getToken() - 获取token
• setToken(token) - 设置token
• removeToken() - 移除token
• getUserInfo() - 获取用户信息
• setUserInfo(userInfo) - 设置用户信息
• removeUserInfo() - 移除用户信息
• getCompanyCode() - 获取公司编码
• setCompanyCode(code) - 设置公司编码
• removeCompanyCode() - 移除公司编码
• getCompanyName() - 获取公司名称
• setCompanyName(name) - 设置公司名称
• removeCompanyName() - 移除公司名称

常量

• CacheKey - Cookie缓存键名常量
• publicKey - 公钥
• version - 工具库版本

Build

# 构建生产版本
npm run build

# 开发模式（监听文件变化）
npm run dev

License

MIT