# @cloudbase/functions-framework 中文文档

规范地址：https://npmcn.com/package/%40cloudbase/functions-framework/

版本：1\.18\.2
npm 元数据更新时间：2026-09-09T07:53:53.999Z
中文译文更新时间：2026-11-10T04:58:14.272Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cloudbase/functions-framework
原文对照：https://npmcn.com/package/%40cloudbase/functions-framework/?lang=original

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

- 包体积（解压后）：334 kB，145 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：21 个
- 首次发布：2024-07-26T03:22:00.963Z
- 最新版本发布：2026-04-14T13:47:07.082Z
- 近 30 天下载量：2102（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 2 个）

## 中文简介

一个基于 `Koa` 托管 Node.js 云函数的框架，使用该框架可以将函数部署至容器环境中，或在本地调试。Node.js 最小依赖版本 `>=18.0.0`。

## 安装

```sh
npm install @cloudbase/functions-framework
```

也可以使用：`pnpm add @cloudbase/functions-framework`、`yarn add @cloudbase/functions-framework`、`bun add @cloudbase/functions-framework`

## README

# README

一个基于 `Koa` 托管 Node.js 云函数的框架，使用该框架可以将函数部署至容器环境中，或在本地调试。Node.js 最小依赖版本 `>=18.0.0`。

参考 [示例](https://npmcn.com/package/%40cloudbase/functions-framework/examples) 了解如何使用。

## 文档

-   [框架使用文档](https://npmcn.com/package/%40cloudbase/functions-framework/docs/framework-usage.md)
-   [函数编写指南](https://npmcn.com/package/%40cloudbase/functions-framework/docs/function-writing-guide.md)

## 常见问题

### @cloudbase/functions-framework 是什么？

一个基于 Koa 托管 Node\.js 云函数的框架，使用该框架可以将函数部署至容器环境中，或在本地调试。Node\.js 最小依赖版本 \>=18\.0\.0。

### 如何安装 @cloudbase/functions-framework？

在项目目录运行 npm install @cloudbase/functions-framework，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 tcb-ff，可以用 npx tcb-ff 直接运行。

### @cloudbase/functions-framework 支持 TypeScript 吗？

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

### @cloudbase/functions-framework 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cloudbase/functions-framework 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cloudbase/functions-framework 可以商用吗？

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

### @cloudbase/functions-framework 的下载量有多少？

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

### @cloudbase/functions-framework 还在维护吗？

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