# @gobing-ai/ts-utils 中文文档

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

版本：0\.7\.1
npm 元数据更新时间：2026-10-25T00:55:09.379Z
中文译文更新时间：2026-11-16T17:48:04.017Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40gobing-ai/ts-utils
原文对照：https://npmcn.com/package/%40gobing-ai/ts-utils/?lang=original
项目主页：https://github.com/gobing-ai/ts-libs#readme
源码仓库：https://github.com/gobing-ai/ts-libs

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

- 包体积（解压后）：85.9 kB，50 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-29T16:58:57.534Z
- 最新版本发布：2026-10-25T00:55:09.046Z
- 近 30 天下载量：4872（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：137（近 12 个月 137 个）

## 中文简介

零依赖性 TypeScript 工具用于日期,光标,出错,输出,出处,角色,以及API响应.

## 安装

```sh
npm install @gobing-ai/ts-utils
```

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

## README

# @gobing-ai/ts-utils (英语)

共享的公用设备——出错类型,日期帮助器,以光标为基础的页码,以角色为基础的访问控制,API响应构建器,以及输出格式化. 没有平台依赖性;在Bun,Node,和Cloudflare工人工作.

## 概览

`ts-utils` 提供小型、可堆肥的公用事业 `ts-runtime`, (中文(简体) ), `ts-db`, (中文(简体) ), `ts-infra`,和应用程序代码。 每个模块都是自成一体的,没有外部依赖性.

| 模块 | 目的 |
| --- | --- |
| `errors` | 输入的应用程序出错( E)`AppError`, (中文(简体) ), `NotFoundError`, (中文(简体) ), `ValidationError`页:1 |
| `date` | `nowMs()`,时间戳 #% 日期转换 |
| `cursor` | 以光标为基础的 Base64url- 编码光标 |
| `access` | Zitadel + 通用角色访问控制(`hasRole`, (中文(简体) ), `getRoles`(中文(简体) ) |
| `api-response` | 标准 API 响应信封构建器 |
| `output` | 人可读输出辅助器(表、JSON等) |
| `origin` | 请求来源解析 |
| `const` | 共享常数 |

## 建筑

```mermaid
classDiagram
    class AppError {
        +ErrorCode code
        +string message
    }

    class NotFoundError {
    }

    class ValidationError {
    }

    class ConflictError {
    }

    class InternalError {
        +unknown cause?
    }

    class ErrorCode {
        <<enumeration>>
        NotFound
        Validation
        Conflict
        Internal
    }

    class CursorData {
        <<interface>>
        +string id
        +number createdAt?
        +number offset?
    }

    class CursorHelpers {
        +createCursor(id, createdAt?, offset?) CursorData
        +parseCursor(data) CursorData
        +encodeCursor(cursor) string
        +decodeCursor(encoded) string
        +encodeCursorFromItem(id, createdAt?, offset?) string
        +decodeAndParseCursor(encoded) CursorData
        +buildCursorMeta(items, limit, hasMore) object
    }

    class DateHelpers {
        +nowMs() number
        +toMs(input) number | null
        +fromMs(ms) Date | null
    }

    class AccessControl {
        +hasRole(profile, role) boolean
        +getRoles(profile) string[]
    }

    AppError <|-- NotFoundError
    AppError <|-- ValidationError
    AppError <|-- ConflictError
    AppError <|-- InternalError
    AppError --> ErrorCode
```

## 如何运作

### 错误类型

带有出错代码的已打出错误等级——消费者按类型而不是字符串抓取 :

```ts
throw new NotFoundError(`User ${userId} not found`);
throw new ValidationError('Email is required');
throw new InternalError('DB connection lost', originalError);

// Callers can discriminate:
if (error instanceof NotFoundError) {
    return new Response(null, { status: 404 });
}
if (isAppError(error)) {
    // error.code is typed: 'NOT_FOUND' | 'VALIDATION' | 'CONFLICT' | 'INTERNAL'
}
```

### 基于光标的平面

从页面中最后一个项目编码光标, 返回客户端, 在下一个请求中解码 :

```ts
import { encodeCursorFromItem, decodeAndParseCursor } from '@gobing-ai/ts-utils';

// Page 1: encode cursor from last item
const cursor = encodeCursorFromItem(lastItem.id, lastItem.createdAt);
// → "eyJpZCI6ImFiYyIsImNyZWF0ZWRBdCI6MTcwMDAwMDAwMH0"

// Page 2: decode cursor from query param
const parsed = decodeAndParseCursor(requestCursor);
// → { id: "abc", createdAt: 1700000000 }

// Build pagination metadata
const meta = buildCursorMeta(items, limit, hasMore);
// → { nextCursor: "eyJ...", hasMore: true, limit: 20 }
```

**光标流量 :**

```mermaid
sequenceDiagram
    Client->>API: GET /items?limit=20
    API->>DB: SELECT ... LIMIT 20
    DB-->>API: 20 rows
    API->>API: encodeCursorFromItem(lastItem)
    API-->>Client: { items: [...], nextCursor: "eyJ..." }

    Client->>API: GET /items?limit=20&cursor=eyJ...
    API->>API: decodeAndParseCursor("eyJ...")
    API->>DB: SELECT ... WHERE id > "abc" LIMIT 20
    DB-->>API: 20 rows
    API-->>Client: { items: [...], nextCursor: "..." }
```

### 基于角色的出入控制

支持 Zitadel IAM 角色和通用角色阵列/对象:

```ts
import { hasRole, getRoles } from '@gobing-ai/ts-utils';

// Zitadel profile
const profile = {
    'urn:zitadel:iam:org:project:roles': { admin: 'project-1', viewer: 'project-1' },
};
hasRole(profile, 'admin'); // → true
getRoles(profile); // → ['admin', 'viewer']

// Generic roles array
hasRole({ roles: ['editor', 'viewer'] }, 'editor'); // → true

// Object-based roles
hasRole({ roles: { admin: true } }, 'admin'); // → true
```

### 日期公用事业

```ts
import { nowMs, toMs, fromMs } from '@gobing-ai/ts-utils';

const ts = nowMs(); // → 1700000000000

toMs(new Date('2024-01-01')); // → 1704067200000
toMs('2024-01-01'); // → 1704067200000
toMs(null); // → null

fromMs(1704067200000); // → Date('2024-01-01')
fromMs(null); // → null
```

## 使用量

### 安装

```bash
bun add @gobing-ai/ts-utils
```

### 共同模式

```ts
import {
    AppError, NotFoundError, ValidationError, ConflictError, InternalError,
    nowMs, toMs, fromMs,
    encodeCursorFromItem, decodeAndParseCursor, buildCursorMeta,
    hasRole, getRoles,
} from '@gobing-ai/ts-utils';

// Errors
function getUser(id: string) {
    const user = db.find(id);
    if (!user) throw new NotFoundError(`User ${id} not found`);
    return user;
}

// Pagination
async function listUsers(limit: number, cursor?: string) {
    const parsed = cursor ? decodeAndParseCursor(cursor) : undefined;
    const users = await db.query(limit, parsed?.id);
    const hasMore = users.length === limit;
    return {
        items: users,
        ...buildCursorMeta(users, limit, hasMore),
    };
}

// Auth guard
function requireAdmin(profile: unknown) {
    if (!hasRole(profile as Record<string, unknown>, 'admin')) {
        throw new ForbiddenError('Admin access required');
    }
}
```

## 常见问题

### @gobing-ai/ts-utils 是什么？

零依赖性 TypeScript 工具用于日期,光标,出错,输出,出处,角色,以及API响应\.

### 如何安装 @gobing-ai/ts-utils？

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

### @gobing-ai/ts-utils 支持 TypeScript 吗？

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

### @gobing-ai/ts-utils 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gobing-ai/ts-utils 可以商用吗？

@gobing-ai/ts-utils 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @gobing-ai/ts-utils 的下载量有多少？

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

### @gobing-ai/ts-utils 还在维护吗？

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

