# @flywheel-io/extension 中文文档

规范地址：https://npmcn.com/package/%40flywheel-io/extension/

版本：0\.14\.10
npm 元数据更新时间：2026-10-29T22:41:00.885Z
中文译文更新时间：2026-11-15T03:12:14.858Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：153 kB，52 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2021-06-09T18:05:08.818Z
- 最新版本发布：2026-10-29T22:41:00.695Z
- 近 30 天下载量：2637（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 3 个）

## 中文简介

为 Flywheel 网络 UI 创建扩展应用程序

## 安装

```sh
npm install @flywheel-io/extension
```

也可以使用：`pnpm add @flywheel-io/extension`、`yarn add @flywheel-io/extension`、`bun add @flywheel-io/extension`

## README

# 飞轮扩展 SDK

以自定义应用程序扩展 Flywheel UI .

## 开始

### 与国家预防机制安装

```shell
npm install @flywheel-io/extension
```

初始化扩展并连接到 Flywheel.

```js
import { initExtension } from '@flywheel-io/extension';

initExtension().then(extension => {
  console.log('Container Type:', extension.container.container_type);
  console.log('Container ID:', extension.container._id);
  console.log('File Name:', extension.file.name);
});
```

### 装入 UMD 模块

作为与国家预防机制捆绑的替代办法,SDK可以通过下列方式装入: `script` 标签。 图书馆可在 `Flywheel` 全球变量.

```html
<body>
  <pre id="content"></pre>
  <script src="https://cdn.flywheel.io/sdk/extension/flywheel-extension-0.14.10.min.js"></script>
  <script>
    Flywheel.initExtension().then(extension => {
      return extension.getFileText(extension.container, extension.file);
    }).then(text => {
      document.getElementById('content').innerText = text;
    });
  </script>
</body>
```

### 正在注册您的申请

Flywheel 站点管理员可以在站点注册扩展申请 - > 申请页. 单击注册新应用程序按钮将容器或文件类型与您的应用程序关联。 URL可以指向本地开发服务器,直到您的应用程序准备好并发布到一个公共地点.

了解更多有关申请登记的信息 [飞轮 Docs](https://docs.flywheel.io/Developer_Guides/extension_apps/#registration-location)。 。 。 .

## 扩展接口

这个 [延长](https://cdn.flywheel.io/docs/extension/latest/classes/Extension.html) 实例建立扩展名的用户、容器和文件上下文。 它还提供与Flywheel相互作用的方法来获取分层的容器,检索文件数据,或者将数据保存回Flywheel. 这些方法大多返回承诺,但有些方法涉及较多(例如: [上传文件](https://cdn.flywheel.io/docs/extension/latest/classes/Extension.html#uploadFile) 方法)返回可订阅的可观察值.

```js
extension.getContainer('session', extension.container.parents.session).then(session => {
  extension.uploadFile(session, fileInput.files[0]).subscribe({
    next: event => {
      if (event.type === 'progress') {
        console.log('uploaded', event.loaded, '/', event.total, 'bytes');
      }
      if (event.type === 'response') {
        console.log('upload complete');
        console.dir(event.file);
      }
    }
  });
});
```

## 扩展范围

初始化扩展并连接到 Flywheel 实例时,您的应用程序将被设定为 _仅读_ 默认范围。 这意味着你能够从Flywheel读取数据,但无法写入数据,例如设置自定义信息或上传文件. 如果你想选择写入功能,请通过 _读取_ `scope` 选项,连同 `validateOrigin` 函数,输入 `initExtension`编辑 [验证奥里金](https://cdn.flywheel.io/docs/extension/0.14.10/interfaces/ExtensionOptions.html#validateOrigin) 函数收到连接的 Flywheel 实例的出处,并将其确定为可信与否.

```js
initExtension({ scope: 'ReadWrite', validateOrigin: origin => origin.endsWith('flywheel.io') }).then(extension => {
  return extension.updateContainerInfo(extension.container, {
    set: {
      ProjectPolicy: {
        owner: 'me@flywheel.io',
        writable: true,
      }
    }
  })
});
```

## 关闭按钮

飞轮在扩展框上画出一个关闭按钮. 为了隐藏它,通过 `hideCloseButton` 选项进入 `initExtension` 打电话 `extension.close()` 从你的应用程序的 自己密切控制.

```js
initExtension({ hideCloseButton: true }).then(extension => {
  document.getElementById('exit').addEventListener('click', () => extension.close());
});
```

## 数据模型

文件介绍了飞轮物体的模型。 其中最常用的有:

-   [集装箱](https://cdn.flywheel.io/docs/extension/0.14.10/interfaces/Container.html)
-   [文件](https://cdn.flywheel.io/docs/extension/0.14.10/interfaces/File.html)
-   [用户](https://cdn.flywheel.io/docs/extension/0.14.10/interfaces/User.html)

当通过国家防范机制在TypeScript项目中安装这个软件包时,这些定义在您的项目环境中提供.

## 常见问题

### @flywheel-io/extension 是什么？

为 Flywheel 网络 UI 创建扩展应用程序

### 如何安装 @flywheel-io/extension？

在项目目录运行 npm install @flywheel-io/extension，或使用 pnpm add / yarn add / bun add。

### @flywheel-io/extension 支持 TypeScript 吗？

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

### @flywheel-io/extension 支持 ESM 还是 CommonJS？

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

### @flywheel-io/extension 可以商用吗？

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

### @flywheel-io/extension 的下载量有多少？

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

### @flywheel-io/extension 还在维护吗？

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