# @dxos/functions 中文文档

规范地址：https://npmcn.com/package/%40dxos/functions/

版本：0\.10\.0
npm 元数据更新时间：2026-07-02T22:01:14.938Z
中文译文更新时间：2026-11-13T01:49:04.972Z
软件包许可：FSL-1\.1-Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dxos/functions
原文对照：https://npmcn.com/package/%40dxos/functions/?lang=original
项目主页：https://dxos.org/
源码仓库：https://github.com/dxos/dxos

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

- 包体积（解压后）：345 kB，46 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：18 个
- 首次发布：2023-07-13T15:04:16.374Z
- 最新版本发布：2026-07-02T22:01:14.565Z
- 近 30 天下载量：2576（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：2242（近 12 个月 57 个）

## 中文简介

函数 API.

## 安装

```sh
npm install @dxos/functions
```

也可以使用：`pnpm add @dxos/functions`、`yarn add @dxos/functions`、`bun add @dxos/functions`

## README

# @dxos/函数

函数 SDK.

## 安装

```bash
pnpm i @dxos/functions
```

## 写入函数

在软件包根创建显示文件 :

```yaml
functions:
  hello:
    description: Test function.
```

> 注:函数名必须与文件名相匹配(例如, `src/functions/hello.ts`) (中文(简体) ).

创建示例函数 :

```ts
import { FunctionContext } from '@dxos/functions';

export default (event: any, context: FunctionContext) => {
  const identity = context.client.halo.identity.get();
  return context.status(200).succeed({
    message: `Hello ${identity?.profile?.displayName}`,
  });
};
```

## 使用 Dev 服务器运行的函数 :

配置在指定端口运行函数的代理 :

```yaml
# ~/.config/dx/profile/default.yml
runtime:
  agent:
    functions:
      port: 7001
```

以 Dev 模式( 从相關套件) 启动函数 :

```bash
dx function dev -r ts-node/register --verbose
```

> 注: `-r ts-node/register` 配置本地类型脚本支持.

安装 `nodemon` 支持实时重装:

```bash
npm i -g nodemon

nodemon -w ./src -e ts --exec $(git rev-parse --show-toplevel)/packages/devtools/cli/bin/dev \
  function dev -r ts-node/register --verbose
```

## 引用函数

> 注:端口(7001)必须与配置中的端口相匹配.

```bash
curl http://localhost:7001/dev/hello -X POST -H 'Content-Type: application/json' -w '\n' --data '{ "message": "Hello World!" }'
```

## DXOS 资源

-   [网站](https://dxos.org/)
-   [开发者文档](https://docs.dxos.org/)
-   跟我们谈谈 [解析器](https://dxos.org/discord)

## 捐款

你的想法、问题和守则非常受欢迎。 请看看我们 [社区行为守则](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md),则 [问题指南](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues),则 [公关贡献指南](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs)。 。 。 .

许可证 : [FSL-1.1-Apache-2.0 导弹发射器](https://npmcn.com/package/%40dxos/functions/LICENSE) 版权 2022 © DXOS

## 常见问题

### @dxos/functions 是什么？

函数 API\.

### 如何安装 @dxos/functions？

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

### @dxos/functions 支持 TypeScript 吗？

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

### @dxos/functions 支持 ESM 还是 CommonJS？

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

### @dxos/functions 可以商用吗？

@dxos/functions 使用 FSL-1\.1-Apache-2\.0 许可。声明的许可为 FSL-1\.1-Apache-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @dxos/functions 的下载量有多少？

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

### @dxos/functions 还在维护吗？

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