# @goast/typescript 中文文档

规范地址：https://npmcn.com/package/%40goast/typescript/

版本：0\.9\.3
npm 元数据更新时间：2026-11-16T09:48:19.075Z
中文译文更新时间：2026-11-16T17:34:00.632Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：589 kB，175 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-01-24T16:43:11.887Z
- 最新版本发布：2026-11-16T09:48:18.692Z
- 近 30 天下载量：5120（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：83（近 12 个月 24 个）

## 中文简介

提供gOAst生成器,用于从OpenAPI规格生成TypeScript代码.

## 安装

```sh
npm install @goast/typescript
```

也可以使用：`pnpm add @goast/typescript`、`yarn add @goast/typescript`、`bun add @goast/typescript`

## README

# gOAst (@goast/ typescript) (英语)

[![@goast/typescript NPM Version](https://img.shields.io/npm/v/%40goast%2Ftypescript?logo=npm&label=%40goast%2Ftypescript)](https://www.npmjs.com/package/@goast/typescript)

**目标** 代表着 **页:1**启动 **欧**笔 **A 类**个人信息 **编号**修饰 **页:1**ransformer,一个用于转换的工具 OpenAPI规格分为多种形式,其核心具有灵活性和可扩展性.

详情请访问 [gOst GitHub 仓库](https://github.com/MaSch0212/goast/blob/main)。 。 。 .

## 目标

这个 `@goast/typescript` 软件包提供发电机 [类型脚本](https://www.typescriptlang.org/) 代码生成 从 OpenAPI 规格.

## 用法示例 QQ

```typescript
import { OpenApiGenerator } from '@goast/core';
import { TypeScriptFetchClientsGenerator, TypeScriptModelsGenerator } from '@goast/typescript';

async function main() {
  await new OpenApiGenerator({ outputDir: '.api' })
    .useType(TypeScriptModelsGenerator)
    .useType(TypeScriptFetchClientsGenerator)
    .parseAndGenerateFromDir('.openapi');
}

main();
```

## 可用发电机

-   [`TypeScriptModelsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Models%20Generator): 生成 OpenAPI 规格中来自 schemas 的 TypeScript 接口或类型.
-   [`TypeScriptFetchClientsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Fetch%20Clients%20Generator)数字 : 生成从 OpenAPI 规格路径获取 TypeScript 客户端 .
    -   取决于产出 `TypeScriptModelsGenerator` 发电机.
-   [`TypeScriptAngularServicesGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Angular%20Services%20Generator)数字 : 生成 [角质](https://angular.dev/) 来自OpenAPI规格中的路径的服务.
    -   取决于产出 `TypeScriptModelsGenerator` 发电机.
-   [`TypeScriptEasyNetworkStubsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Easy%20Network%20Stubs%20Generator)数字 : 生成 [网易站点](https://github.com/LoaderB0T/easy-network-stub) 从 OpenAPI 路径的分类 规格.
    -   取决于产出 `TypeScriptModelsGenerator` 发电机.
-   [`TypeScriptK6ClientsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20K6%20Clients%20Generator)数字 : 生成 [k6 时](https://k6.io/) 客户端来自OpenAPI规格中的路径.
    -   取决于产出 `TypeScriptModelsGenerator` 发电机.

## API 文档 QQ

API 文档可见 [这里](https://github.com/MaSch0212/goast/wiki/TypeScript%20Generators)。 。 。 .

## 常见问题

### @goast/typescript 是什么？

提供gOAst生成器,用于从OpenAPI规格生成TypeScript代码\.

### 如何安装 @goast/typescript？

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

### @goast/typescript 支持 TypeScript 吗？

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

### @goast/typescript 支持 ESM 还是 CommonJS？

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

### @goast/typescript 可以商用吗？

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

### @goast/typescript 的下载量有多少？

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

### @goast/typescript 还在维护吗？

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

