# @anvilco/types 中文文档

规范地址：https://npmcn.com/package/%40anvilco/types/

版本：0\.2\.5
npm 元数据更新时间：2026-11-05T21:30:58.728Z
中文译文更新时间：2026-11-06T22:22:36.525Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：703 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2026-05-19T17:59:52.529Z
- 最新版本发布：2026-11-05T21:30:58.400Z
- 近 30 天下载量：2263（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

由 Anvil OpenAPI 光谱和 GraphQL 方案生成的脚本类型

## 安装

```sh
npm install @anvilco/types
```

也可以使用：`pnpm add @anvilco/types`、`yarn add @anvilco/types`、`bun add @anvilco/types`

## README

# @anvilco/ 类型

类型脚本类型 [安维尔](https://www.useanvil.com/) OpenAPI spec and GraphQL schema. \[永久失效連結\] OpenAPI spec and GraphQL schema. 内部使用 `@anvilco/browser` 财务报告和审定财务报表 `@anvilco/react`。 。 。 .

Anvil SDK 类型脚本的唯一位置:

-   **资源**数字 : `paths`, (中文(简体) ), `components` 财务报告和审定财务报表 `operations`,从 OpenAPI 光谱中生成,加上填入-PDF 请求类型(`FillPdfPayload`, (中文(简体) ), `FillPdfData`, (中文(简体) ), `FillPdfOptions`) (中文(简体) ).
-   **爱奇**数字 : `CreateEtchPacketArgs`, 创建EtchPacket突变与 GraphQL 计划调用的参数 `JSON` 键入 : `signers` (单位:千美元)`EtchSigner`, (中文(简体) ), `signaturePageOptions` (单位:千美元)`EtchSignaturePageOptions`和 `finishPageOptions` (单位:千美元)`EtchFinishPageOptions`) (中文(简体) ). OpenAPI spec发布其形状.
-   **图QL**页:1 `GraphQL` 命名空间, 由 schema 生成.
-   **SDK自己的类型**数字 : `AnvilOptions`, (中文(简体) ), `GraphQLResponse`, (中文(简体) ), `RESTResponse`, (中文(简体) ), `ResponseError`, (中文(简体) ), `ResponseErrorField`, (中文(简体) ), `RuntimeError` 财务报告和审定财务报表 `Abortable`。 。 。 .

```ts
import type { GraphQL } from '@anvilco/types'

type Packet = GraphQL.Type<'EtchPacket'> // any type in the schema, by name
type WeldFile = GraphQL.Type<'WeldFile'> // input types too: nullable fields are optional
type Args = GraphQL.MutationArgs<'createEtchPacket'> // the arguments of any mutation
type PacketArgs = GraphQL.QueryArgs<'etchPacket'> // …or query
```

对象类型将整个对象描述为计划定义的对象. 一个查询只返回它选择的字段,所以对于您获取的数据,使用查询结果的类型.

自定义平面由 `GraphQL.Scalars`数字 : `Date` 是一个 ISO 8601 `string`, (中文(简体) ), `JSON` 实值 `unknown`,以及 `Upload` 实值 `Blob | { data: string; mimetype: string; filename: string } | { url: string; filename?: string }`。 。 。 .

## 图QL 操作

运行查询和变异,使用 [`@anvilco/core`](https://npmcn.com/package/%40anvilco/core/README.md)。 。 `graphql` 文档按此方案键入.

这些类型的规格也来源于与软件包一起的船舶,用于构建工具:GraphQL schema at `@anvilco/types/schema.graphql` 和 OpenAPI 显示 `@anvilco/types/openapi.json`其他Anvil API客户([蟒蛇 - 安维尔](https://github.com/anvilco/python-anvil), (中文(简体) ), [点网-安维尔](https://github.com/anvilco/dotnet-anvil))从它们中生成出它们的类型,因此每个客户端都描述了相同的API. 导入 `@anvilco/types` 从不在运行时装入它们.

## 重新生成

类型在每次Anvil生产部署后从生产中再生(`.github/workflows/sync-api-types.yml`),当它们改变时打开了公关. 用手再生:

-   瑞丝: `yarn workspace @anvilco/types generate:rest` 刷新点 `schema/openapi.json` 从生产和重建 `src/rest.ts` 从它.
-   图QL : `ANVIL_API_KEY_PROD_BASE64=... yarn workspace @anvilco/types fetch:schema` 刷新点 `schema/anvil-schema.graphql` 从生产,然后 `yarn workspace @anvilco/types generate:graphql` 重建 `src/graphql/generated/` 从它。 第二步不需要网络接入或密钥,这是CI检查的内容.

## 常见问题

### @anvilco/types 是什么？

由 Anvil OpenAPI 光谱和 GraphQL 方案生成的脚本类型

### 如何安装 @anvilco/types？

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

### @anvilco/types 支持 TypeScript 吗？

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

### @anvilco/types 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @anvilco/types 需要什么版本的 Node\.js？

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

### @anvilco/types 可以商用吗？

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

### @anvilco/types 的下载量有多少？

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

### @anvilco/types 还在维护吗？

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