# @brendanbank/atrium-host-types 中文文档

规范地址：https://npmcn.com/package/%40brendanbank/atrium-host-types/

版本：0\.32\.5
npm 元数据更新时间：2026-11-08T20:40:25.310Z
中文译文更新时间：2026-11-10T00:35:36.974Z
软件包许可：BSD-2-Clause

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

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

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

- 包体积（解压后）：22 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-04-29T09:05:50.519Z
- 最新版本发布：2026-11-08T20:40:24.937Z
- 近 30 天下载量：1691（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 52 个）

## 中文简介

Atrium主机-扩展合同的TypeScript声明: Atrium Registry, UserContext, AdminUserRow, Attrium Notification, Atrium Event. 真实源会塑造一个主机捆绑类型, 并与 Atrium 已公布的图像主. minor 同步 .

## 安装

```sh
npm install @brendanbank/atrium-host-types
```

也可以使用：`pnpm add @brendanbank/atrium-host-types`、`yarn add @brendanbank/atrium-host-types`、`bun add @brendanbank/atrium-host-types`

## README

# `@brendanbank/atrium-host-types`

类型脚本声明 [ium](https://github.com/brendanbank/atrium) 主机延伸合同.

```ts
import type {
  AtriumRegistry,
  AtriumNotification,
  AtriumEvent,
  UserContext,
  AdminUserRow,
} from '@brendanbank/atrium-host-types';

const reg = window.__ATRIUM_REGISTRY__ as AtriumRegistry;
reg.registerHomeWidget({ key: 'my-card', render: () => /* ... */ });
```

软件包是 **仅类型** 没有运行时间,没有JS有效载荷运行时间. 邦德勒斯将其从生产产出中剥离.

## 安装

```bash
pnpm add -D @brendanbank/atrium-host-types
```

该套件发布于公共npm注册. 没有 `.npmrc`, (中文(简体) ), 没有证明,没有PAT。 如果你在v.0.15.1和 有个 `@brendanbank:registry=https://npm.pkg.github.com` 线条在  `.npmrc`,删除它 — npmjs.org 是默认注册.

## 版本

包版本跟踪 Atrium的图像版本. 键 `^0.32` 页:1 "可与原子0.32.x相兼容";与原子图像相撞 用于取取新的登记位置。 新建插槽 **选项** 成员 打开 `AtriumRegistry` 先是还没有撞倒的宿主 类型检查.

## 什么样的船

-   `AtriumRegistry` ——每个 `register*` 槽原子曝光加 `subscribeEvent`。 。 。 .
-   `UserContext` —— 说 `/users/me/context` 形状.
-   `AdminUserRow` —— 说 `/admin/users` 排行形状.
-   `AtriumNotification` ——通知行体.
-   `AtriumEvent` 编号 : `AtriumEventHandler` ——SSE键入事件形状.
-   每秒选项包类型 : `HomeWidget`, (中文(简体) ), `RouteEntry`, (中文(简体) ), `NavItem`, (中文(简体) ), `AdminTab`, (中文(简体) ), `ProfileItem`, (中文(简体) ), `NotificationKindRenderer`, (中文(简体) ), `LocaleOverlay`。 。 。 .
-   `ProfileSlot`, (中文(简体) ), `HomeWidgetWidth` ——弦联.
-   A 类 `declare global` 块,该类型 `window.React`, (中文(简体) ), `window.__ATRIUM_VERSION__`,以及 `window.__ATRIUM_REGISTRY__`。 。 。 .

## 另见

-   [`@brendanbank/atrium-host-bundle-utils`](https://npmcn.com/package/%40brendanbank/host-bundle-utils/) —— 说 运行时帮助器,Vite预设和回放钩. 再出口类型 从这个软件包中,所以只添加一个 dep 的主机仍然得到 声明.
-   [`docs/published-images.md`](https://npmcn.com/package/docs/published-images.md) - 那个 完整的主机扩展合同(图像目录、装载器行为、, 登记语义).
-   [`docs/compat-matrix.md`](https://npmcn.com/package/docs/compat-matrix.md) - 哪个 原子释放增加了哪个槽.

## 常见问题

### @brendanbank/atrium-host-types 是什么？

Atrium主机-扩展合同的TypeScript声明: Atrium Registry, UserContext, AdminUserRow, Attrium Notification, Atrium Event\. 真实源会塑造一个主机捆绑类型, 并与 Atrium 已公布的图像主\. minor 同步 \.

### 如何安装 @brendanbank/atrium-host-types？

在项目目录运行 npm install @brendanbank/atrium-host-types，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @brendanbank/atrium-host-types 支持 TypeScript 吗？

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

### @brendanbank/atrium-host-types 支持 ESM 还是 CommonJS？

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

### @brendanbank/atrium-host-types 可以商用吗？

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

### @brendanbank/atrium-host-types 的下载量有多少？

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

### @brendanbank/atrium-host-types 还在维护吗？

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