# @craftercms/utils 中文文档

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

版本：4\.3\.0
npm 元数据更新时间：2025-02-20T17:49:50.495Z
中文译文更新时间：2026-11-10T22:55:22.304Z
软件包许可：GNU LGPL 3\.0

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

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

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

- 包体积（解压后）：92 kB，39 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2018-07-30T19:09:49.567Z
- 最新版本发布：2025-02-20T17:49:50.300Z
- 近 30 天下载量：4697（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 0 个）

## 中文简介

CMS 工具与助手函数

## 安装

```sh
npm install @craftercms/utils
```

也可以使用：`pnpm add @craftercms/utils`、`yarn add @craftercms/utils`、`bun add @craftercms/utils`

## README

![npm (scoped)](https://img.shields.io/npm/v/@craftercms/utils?style=plastic)

# @ cramercms/ utils (英语)

包含 Crafter CMS 开发时有用的各种公用设施

## 使用量

所有 Crafter CMS 包都可以通过 npm 使用,也可以通过常规脚本导入在 plain html/javascript中使用.

### 通过 npm

-   `yarn add @craftercms/utils` 或者说 `npm install @craftercms/utils`
-   `import` 或者说 `require` 您想要的函数.

### Via html 脚本导入

-   下载捆绑并在您的页面中导入 .
-   捆绑声明一个名为全局变量 `craftercms`。 您可以在此根下访问所有 Frapercms 的软件包和函数.
-   这个 `utils` 软件包依赖于 rxjs, 在 rxj 之前确保导入 rxjs `utils` 剧本.

**提示**: 一旦导入脚本, 类型 `craftercms` 在浏览器的 dev 工具控制台上检查软件包

#### Vanilla html/js 实例

```html
<div id="myFeature"></div>
<script src="https://unpkg.com/rxjs"></script>
<script src="https://unpkg.com/@craftercms/utils"></script>
<script>
 (function ({ utils }) {

   const people = [
     { id: 1, name: 'Mary' }
   ]

   const myLookup = utils.createLookupTable(people);
   console.log(myLookup); // => { 1: { id: 1, name: 'Mary' } }

 })(craftercms);
</script>
```

## 软件包索引

以下示例假设使用方式为 npm 。 如果你在使用捆绑, 直接导入浏览器中的脚本, 这些功能将在全局变量下 名称 `craftercms.utils` (即说. `window.craftercms.utils`) (中文(简体) ).

### 创建搜索表

创建基于(类型)项目数组和项目 ID 标识符的查询表.

#### 示例

-   创建项目查询表 :

```typescript
import { Item, LookupTable } from "@craftercms/models";
import { createLookupTable } from "@craftercms/utils";

const items: Item[] = [/* ... */];
const itemsLookupTable: LookupTable<Item> = createLookupTable<Item>(items, 'url');
```

搜索表会是这样的:

```json
  {
    "/site/website/index.xml": {
      "name": "index.xml",
      "url": "/site/website/index.xml",
      "descriptorUrl": "/site/website/index.xml",
      "descriptorDom": { /* ... */ },
      "folder": false
    }
  }
```

## 常见问题

### @craftercms/utils 是什么？

CMS 工具与助手函数

### 如何安装 @craftercms/utils？

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

### @craftercms/utils 支持 TypeScript 吗？

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

### @craftercms/utils 支持 ESM 还是 CommonJS？

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

### @craftercms/utils 可以商用吗？

@craftercms/utils 使用 GNU LGPL 3\.0 许可。声明的许可为 GNU LGPL 3\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @craftercms/utils 的下载量有多少？

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

### @craftercms/utils 还在维护吗？

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