# @crombolo/delivery-client 中文文档

规范地址：https://npmcn.com/package/%40crombolo/delivery-client/

版本：0\.60\.0
npm 元数据更新时间：2026-11-10T14:45:59.972Z
中文译文更新时间：2026-11-11T01:09:08.921Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40crombolo/delivery-client
原文对照：https://npmcn.com/package/%40crombolo/delivery-client/?lang=original
项目主页：https://github.com/kineco-au/crombolo-cms#readme
源码仓库：https://github.com/kineco-au/crombolo-cms

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

- 包体积（解压后）：35.5 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-22T05:05:27.872Z
- 最新版本发布：2026-11-10T14:45:59.602Z
- 近 30 天下载量：7328（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

一个为crombolo站点的快递API打入的客户端,用于浏览器,节点或Bun中的应用. 无依取相.

## 安装

```sh
npm install @crombolo/delivery-client
```

也可以使用：`pnpm add @crombolo/delivery-client`、`yarn add @crombolo/delivery-client`、`bun add @crombolo/delivery-client`

## README

# @crombolo/ 交付客户端

输入的客户端 [缩写](https://github.com/kineco-au/crombolo-cms) 网站的 交付API,用于浏览器,节点或Bun中的应用程序. 无相依相.

```sh
npm install @crombolo/delivery-client
# in the site: write its types into the app
bunx crombolo generate --delivery --out ../app/src/cms-types.ts
```

```ts
import { createDeliveryClient, isExpanded } from '@crombolo/delivery-client'
import type { DeliveryTypes } from './cms-types'

const cms = createDeliveryClient<DeliveryTypes>({ baseUrl: 'https://cms.example.com' })

const page = await cms.item('/news/story', { expand: 'properties[related]' })
if (page?.contentType === 'article') {
  console.log(page.properties.title)
  const related = page.properties.related
  if (related && isExpanded(related)) console.log(related.properties)
}

const latest = await cms.content({ fetch: 'children:/news', sort: 'createDate:desc', take: 5 })
const hits = await cms.search('harbour')
```

-   `item`, (中文(简体) ), `items`, (中文(简体) ), `content`, (中文(简体) ), `mediaItem`, (中文(简体) ), `mediaItems`, (中文(简体) ), `media` 财务报告和审定财务报表 `search`, (中文(简体) ), 与API自己的 `expand`, (中文(简体) ), `fields`, (中文(简体) ), `fetch`, (中文(简体) ), `filter` 财务报告和审定财务报表 `sort` 语法.
-   `apiKey`, (中文(简体) ), `culture`, (中文(简体) ), `startItem` 财务报告和审定财务报表 `memberToken` 选项,每个压倒性 每个请求。 在浏览器中运行的代码中保留一个API密钥.
-   没有的东西 `undefined`; 任何其它拒绝的都会扔出一个 `DeliveryError` 联合国 `status` 财务报告和审定财务报表 `body`。 。 。 .
-   另一个来源的浏览器应用程序需要网站允许: `deliveryApi.cors.allowedOrigins`。 。 。 .

该网站的文档描述API和生成的类型: `docs/delivery-api.md`。 。 。 .

## 常见问题

### @crombolo/delivery-client 是什么？

一个为crombolo站点的快递API打入的客户端,用于浏览器,节点或Bun中的应用\. 无依取相\.

### 如何安装 @crombolo/delivery-client？

在项目目录运行 npm install @crombolo/delivery-client，或使用 pnpm add / yarn add / bun add。

### @crombolo/delivery-client 支持 TypeScript 吗？

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

### @crombolo/delivery-client 支持 ESM 还是 CommonJS？

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

### @crombolo/delivery-client 可以商用吗？

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

### @crombolo/delivery-client 的下载量有多少？

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

### @crombolo/delivery-client 还在维护吗？

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