# @gnldev/options 中文文档

规范地址：https://npmcn.com/package/%40gnldev/options/

版本：0\.18\.0
npm 元数据更新时间：2026-11-09T06:00:25.143Z
中文译文更新时间：2026-11-16T17:16:26.397Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：34 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：0 个
- 首次发布：2026-10-05T19:04:51.493Z
- 最新版本发布：2026-11-09T06:00:24.762Z
- 近 30 天下载量：3575（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

每个 GNL 选项对象都有一个规则: 它不取的名称被拒绝,其选项最接近. 无依取相.

## 安装

```sh
npm install @gnldev/options
```

也可以使用：`pnpm add @gnldev/options`、`yarn add @gnldev/options`、`bun add @gnldev/options`

## README

# @ gnldev/ 选项

> 部分 [格陵兰](https://github.com/gnlhq/gnldev), TypeScript 的完整代理框架——与它的其他部分合作,或自行工作.

每个选项对象GNL有一个规则写道: 它不使用的名称被拒绝, 选项是 最亲近.

选项对象按名称读取, 且从未检查是否删除一个拼写错误的名称而无一字 。 计量 横跨此规则之前的 GNL 包: 拼写错误 `authorize` 留下了一扇门,没有它的政策,a 拼写错误 `guard` 留下一个没有看守的特工, `limits.maxToolCall` 让一个工具超越极限, 和特别事务办公室 `issuer` 写入 `isuer` 接受任何发行人的担保 每个对象现在都失败 改为:

```
createChatRoute: `authorise` is not an option — did you mean `authorize`? Nothing would read it, so it would run without it.
```

您不安装此软件包: 每个检查其选项的 GNL 软件包都取决于它 .

## 对于软件包作者

```ts
import { refuseUnknownNames, optionNames } from '@gnldev/options';

interface MyOptions { retries?: number; timeoutMs?: number }

// The list is held to the type by the compiler: a name that is no member, or a member left out, fails typecheck.
const NAMES = optionNames<MyOptions>()(['retries', 'timeoutMs']);

export function myThing(opts: MyOptions = {}) {
  refuseUnknownNames('myThing', opts, NAMES);
  // …
}
```

-   `refuseUnknownNames(where, value, names, removed?)` - 拒绝任何名字不英寸 `names`。 。 。 . `removed` 地图a 之前的选项 句子,说什么代替它.
-   `refuseMisspelledNames(where, value, names)` ——对于一个被传递到另一个库(GNL's `runDurable` 通过AI SDK的选项 `generateText`:一个名字只有在是时才被拒绝 误写一个已知的, 所以一个选项 一个更新版本的库 添加仍然通过.
-   `optionNames<T>()` 编号 : `variantNames<T>()` ——某物体类型的名称列表,或联盟的每个变体的名称.

名称设置为 `undefined` 无名称 : 传播可选值从不被拒绝。 只有选项包 检查——实施接口(存储、模型、提供者)可携带自己的成员.

## 当软件包的选项发生变化时

没有什么需要记住的: 编译器和 `pnpm check:option-names` (CI)说要更新什么.

| 变动 | 失败的 | 修补 |
| --- | --- | --- |
| 添加到选项类型的字段 | 类型检查:名称列表报告 `missing: "<field>"` | 将名称添加到列表 |
| 已删除或更名的字段 | 类型检查: 列表名称类型已不存在的字段 | 把它放下; 说出替换的东西, 将旧名添加到 `removed` 图表 |
| 新建导出函数、 构造器、 方法或选项类型而不检查 | `check:option-names` | 把包递给我 `refuseUnknownNames`,或标记 gnl-内部管道 `@internal — <why>` |
| 一个新的 gnl.config 字段 `gnl dev` | 类型检查 `@gnldev/cli` (双管齐下) `PROJECT_CONFIG_NAMES`(中文(简体) ) | 加上来 `PROJECT_CONFIG_NAMES` 内 `@gnldev/durable` |
| 更新的 AI SDK 添加一个选项 | 对主机无任何信息:一个近于无的名称传递给AI SDK;升级时,打字检查会询问SDK的新名称 | 将它们添加到 AI SDK 列表中 |

一个盲点:工厂返回物体的方法(`createCache(...).set`仅由其 选项类型有列表 - `check:option-names` 无法看到方法体读取它。 审查 在增加这种方法时.

## 常见问题

### @gnldev/options 是什么？

每个 GNL 选项对象都有一个规则: 它不取的名称被拒绝,其选项最接近\. 无依取相\.

### 如何安装 @gnldev/options？

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

### @gnldev/options 支持 TypeScript 吗？

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

### @gnldev/options 支持 ESM 还是 CommonJS？

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

### @gnldev/options 需要什么版本的 Node\.js？

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

### @gnldev/options 可以商用吗？

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

### @gnldev/options 的下载量有多少？

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

### @gnldev/options 还在维护吗？

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

