# @baiwusanyu/utils-com 中文文档

规范地址：https://npmcn.com/package/%40baiwusanyu/utils-com/

版本：1\.1\.2
npm 元数据更新时间：2024-12-12T04:45:25.636Z
中文译文更新时间：2026-11-07T19:23:41.221Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40baiwusanyu/utils-com
原文对照：https://npmcn.com/package/%40baiwusanyu/utils-com/?lang=original
项目主页：https://github.com/baiwusanyu-c
源码仓库：https://github.com/baiwusanyu-c/bwsy-utils

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.5 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：ansi-colors ^4\.1\.3，hash-sum ^2\.0\.0
- 首次发布：2023-05-07T06:59:18.622Z
- 最新版本发布：2024-12-12T04:45:25.486Z
- 近 30 天下载量：2978（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

## 函数

## 安装

```sh
npm install @baiwusanyu/utils-com
```

也可以使用：`pnpm add @baiwusanyu/utils-com`、`yarn add @baiwusanyu/utils-com`、`bun add @baiwusanyu/utils-com`

## README

# @baiwusanyu/utils-com

## Function

### downloadFile

根据下载链接下载文件

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| url | `string` | `-` | 下载链接 |

### createHash

基于 `hash-sum` 生成一个随机哈希

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| id | `string \ number` | `(new Date()).getTime().toString()` | 生成`hash` 的 `id` |
| prefix | `string` | `''` | 自定义前缀 |
| suffix | `string` | `''` | 自定义后缀 |

| 返回值 | 返回类型 | 说明 |
| --- | --- | --- |
| res | `string` | 生成的哈希结果 |

### debounce

防抖函数返回一个新的函数，这个新函数会在 wait 时间内被连续调用时，  
会取消上一次调用并重新开始等待 wait 时间。

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| func | `T extends (...args: any[]) => any` | `-` | 需要进行防抖的函数 |
| wait | `number` | `''` | 等待时间（毫秒），即在该时间内没有新的调用时才会真正地执行 `func` |

| 返回值 | 返回类型 | 说明 |
| --- | --- | --- |
| debounceFn | `(...args: Parameters<T>) => void` | 防抖函数 |

### throttle

节流函数返回一个新的函数，这个新函数会在 wait 时间内被连续调用时，  
只会执行第一次调用，并在 wait 时间后才能再次执行。

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| func | `T extends (...args: any[]) => any` | `-` | 需要进行节流的函数 |
| wait | `number` | `''` | 等待时间（毫秒），即在该时间内只能执行一次 `func` |

| 返回值 | 返回类型 | 说明 |
| --- | --- | --- |
| throttleFn | `(...args: Parameters<T>) => void` | 节流函数 |

### copyText

将字符串复制到粘贴板

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| content | `string` | `-` | 复制内容 |
| resolve | `() => void` | `-` | 调用成功回调 |
| err | `(err: any) => void` | `-` | 调用错误回调 |

### sessionCache

基于 sessionStorage 的缓存函数

#### sessionCache.set

存储缓存

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| key | `string` | `-` | key |
| value | `string` | `-` | 值 |

#### sessionCache.get

获取缓存

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| key | `string` | `-` | key |

| 返回值 | 返回类型 | 说明 |
| --- | --- | --- |
| res | `string` | 缓存数据 |

#### sessionCache.setJSON

以对象格式存储缓存

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| key | `string` | `-` | key |
| value | `any` | `-` | 值 |

#### sessionCache.getJSON

以对象格式获取缓存

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| key | `string` | `-` | key |

| 返回值 | 返回类型 | 说明 |
| --- | --- | --- |
| res | `any` | 缓存数据 |

#### sessionCache.remove

移除缓存

| 参数 | 参数类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| key | `string` | `-` | key |

### localCache

基于 localStorage 的缓存函数, 函数与 sessionCache 相同

## 常见问题

### @baiwusanyu/utils-com 是什么？

函数

### 如何安装 @baiwusanyu/utils-com？

在项目目录运行 npm install @baiwusanyu/utils-com，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ansi-colors（^4\.1\.3）、hash-sum（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @baiwusanyu/utils-com 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @baiwusanyu/utils-com 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @baiwusanyu/utils-com 可以商用吗？

@baiwusanyu/utils-com 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @baiwusanyu/utils-com 的下载量有多少？

根据 npm 官方下载统计，@baiwusanyu/utils-com 在 2026/10/08 – 2026/11/06 这 30 天内被下载 2,978 次，日均约 99 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @baiwusanyu/utils-com 还在维护吗？

最新版本 1\.1\.2 发布于 2024/12/12（1\.9 年前）；至今共发布 13 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/05/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。