# @consumidor-positivo/ts-utils 中文文档

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

版本：1\.35\.1
npm 元数据更新时间：2026-08-04T17:20:27.606Z
中文译文更新时间：2026-11-10T22:36:36.009Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40consumidor-positivo/ts-utils
原文对照：https://npmcn.com/package/%40consumidor-positivo/ts-utils/?lang=original

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

- 包体积（解压后）：125 kB，155 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=17\.0\.0，react-dom \>=17\.0\.0
- 首次发布：2025-05-15T14:42:10.707Z
- 最新版本发布：2026-08-04T17:20:27.356Z
- 近 30 天下载量：2518（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 20 个）

## 中文简介

![TypeScript Utils Logo](http://assets.acordocerto.com.br/f/114280/500x147/81e872f257/typescript-utils.png)

## 安装

```sh
npm install @consumidor-positivo/ts-utils
```

也可以使用：`pnpm add @consumidor-positivo/ts-utils`、`yarn add @consumidor-positivo/ts-utils`、`bun add @consumidor-positivo/ts-utils`

## README

![TypeScript Utils Logo](http://assets.acordocerto.com.br/f/114280/500x147/81e872f257/typescript-utils.png)

# @consumidor-positivo/ts-utils (英语)

用于 Consumidor Positivo 项目的 TypeScript 工具库 .

## 安装

```bash
npm install @consumidor-positivo/ts-utils
```

## 使用量

### 工具函数

```typescript
import { range } from '@consumidor-positivo/ts-utils';

// Generate an array of sequential numbers
const numbers = range(5);
console.log(numbers); // [0, 1, 2, 3, 4]
```

### 反应钩 (可选)

库还提供可单独导入的回放钩. 这些钩子是可选的,需要反应作为同级依赖.

#### 使用 Persisted 状态

```typescript
import { usePersistedState } from '@consumidor-positivo/ts-utils/hooks';

function UserPreferences() {
  // Persist state in localStorage (default)
  const [preferences, setPreferences, clearPreferences] = usePersistedState('user-preferences', {
    theme: 'light',
    fontSize: 14
  });
  
  // Persist state in sessionStorage
  const [sessionData, setSessionData] = usePersistedState('session-data', 
    { isLoggedIn: true }, 
    { storage: 'session' }
  );
  
  const toggleTheme = () => {
    setPreferences({
      ...preferences,
      theme: preferences?.theme === 'light' ? 'dark' : 'light'
    });
  };
  
  return (
    <div>
      <p>Current theme: {preferences?.theme}</p>
      <button onClick={toggleTheme}>Toggle Theme</button>
      <button onClick={clearPreferences}>Reset Preferences</button>
    </div>
  );
}
```

见 [文档](https://ts-utils.consumidorpositivo.com.br/) 用于更详细的示例和 API 参考.

## 发展指导方针

此库旨在包含 **只有通用的公用函数** 可以安全地用于客户端应用程序。 在作出贡献时,请遵守这些重要原则:

-   **没有商业逻辑**: 此库不应包含任何具体业务的逻辑或规则.
-   **无内部请求**:不包括API呼叫或请求内部服务.
-   **无敏感代码**: 避免包含任何敏感信息或算法.
-   **客户端安全**:所有公用设施应适合用于浏览器环境.

这个库的目的是提供可再用,通用的公用功能,帮助不同Consumidor Positivo项目执行共同的编程任务.

## 捐款

请读我们的 [贡献指南](https://npmcn.com/package/%40consumidor-positivo/ts-utils/CONTRIBUTING.md) 详细介绍我们的开发进程、Git工作流程以及如何提交拉动请求.

## 文档

### 生成文档

要生成图书馆文件,请运行:

```bash
npm run docs
```

文件将编入本报告 `docs/` 目录.

### 本地查看文档

要在本地服务器上生成并查看文档, 请运行 :

```bash
npm run docs:serve
```

这将启动一个本地服务器,文件将在http://localhost:3000上提供.

### 建立图书馆和文件

为了建设图书馆和文件,运行:

```bash
npm run build:all
```

## 测试

这个库使用Vitest进行测试. 以下是可用的测试命令 :

### 运行测试

```bash
npm test
```

### 在监视模式下运行测试

```bash
npm run test:watch
```

### 进行覆盖测试

```bash
npm run test:coverage
```

### 用 UI 运行测试

```bash
npm run test:ui
```

## 许可证

独资 - 孔苏米多·波西蒂沃

## 常见问题

### 如何安装 @consumidor-positivo/ts-utils？

在项目目录运行 npm install @consumidor-positivo/ts-utils，或使用 pnpm add / yarn add / bun add。

### @consumidor-positivo/ts-utils 支持 TypeScript 吗？

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

### @consumidor-positivo/ts-utils 支持 ESM 还是 CommonJS？

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

### @consumidor-positivo/ts-utils 可以商用吗？

@consumidor-positivo/ts-utils 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @consumidor-positivo/ts-utils 的下载量有多少？

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

### @consumidor-positivo/ts-utils 还在维护吗？

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