# @wrenautomation/orrery 中文文档

规范地址：https://npmcn.com/package/%40wrenautomation/orrery/

版本：0\.30\.6
npm 元数据更新时间：2026-11-02T22:15:19.482Z
中文译文更新时间：2026-11-02T22:30:27.000Z
软件包许可：PolyForm-Strict-1\.0\.0

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

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

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

- 包体积（解压后）：39.7 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-28T23:58:45.680Z
- 最新版本发布：2026-11-02T22:15:19.167Z
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

折叠地图的逻辑：折叠树、任何引擎上的嵌套布局以及帧之间的滑动。没有渲染器，没有框架。

## 安装

```sh
npm install @wrenautomation/orrery
```

也可以使用：`pnpm add @wrenautomation/orrery`、`yarn add @wrenautomation/orrery`、`bun add @wrenautomation/orrery`

## README

# 太阳系仪

你折叠地图的逻辑。没有渲染器，没有框架：每个地图绘制自己的框架。

-   `tree`折叠树。一个深度切口，加上手工打开或闭合的节点。 `openSet`， `toggle`， `reveal`， `stepDepth`， `fullDepth`.
-   `nest`：在你通过的引擎（ELK，网格，你自己的）上嵌套布局。开放式容器的大小是由孩子决定的。位置加起来就是根。缓存只重放更改过的路径。
-   `glide`：两帧之间的运动。留下的痕迹会滑动，新的痕迹会从锚中生长出来，消失的痕迹会缩小。 `Marks` 说明哪些元素是标记。

不依赖任何东西。在浏览器中运行： `glide` 测量DOM并使用Web动画API。

```sh
npm i @wrenautomation/orrery
```

```ts
import { nest, openSet } from "@wrenautomation/orrery";

const open = openSet(nodes, { depth: 1, open: { "pkg:core": true } });
const map = await nest({ nodes, root: "repo", open, size, pad, engine: myLayout });
// map.boxes: absolute, parents first. map.levels: each open container's own layout.
```

由红隼的观察者和鹪鹩的地铁地图使用。

## 常见问题

### @wrenautomation/orrery 是什么？

折叠地图的逻辑：折叠树、任何引擎上的嵌套布局以及帧之间的滑动。没有渲染器，没有框架。

### 如何安装 @wrenautomation/orrery？

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

### @wrenautomation/orrery 支持 TypeScript 吗？

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

### @wrenautomation/orrery 支持 ESM 还是 CommonJS？

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

### @wrenautomation/orrery 可以商用吗？

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

### @wrenautomation/orrery 还在维护吗？

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