# @cats-oss/ts-proto-optimize 中文文档

规范地址：https://npmcn.com/package/%40cats-oss/ts-proto-optimize/

版本：0\.2\.0
npm 元数据更新时间：2022-10-19T01:12:30.244Z
中文译文更新时间：2026-11-09T07:54:10.177Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cats-oss/ts-proto-optimize
原文对照：https://npmcn.com/package/%40cats-oss/ts-proto-optimize/?lang=original
项目主页：https://github.com/cats-oss/ts-proto-optimize#readme
源码仓库：https://github.com/cats-oss/ts-proto-optimize

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

- 包体积（解压后）：28.1 kB，16 个文件
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2019-08-23T14:06:07.049Z
- 最新版本发布：2022-10-19T01:12:30.153Z
- 近 30 天下载量：3814（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

它是用于优化TypeScript protobuf类型定义文件的CLI工具.

## 安装

```sh
npm install @cats-oss/ts-proto-optimize
```

也可以使用：`pnpm add @cats-oss/ts-proto-optimize`、`yarn add @cats-oss/ts-proto-optimize`、`bun add @cats-oss/ts-proto-optimize`

## README

# `@cats-oss/ts-proto-optimize`

[![Continuous Integration](https://github.com/cats-oss/ts-proto-optimize/actions/workflows/ci.yml/badge.svg)](https://github.com/cats-oss/ts-proto-optimize/actions/workflows/ci.yml)

> **\[警告\]** 它是用于优化TypeScript protobuf类型定义文件的CLI工具.

优化仅用于获得类型安全的原生取出物的定义. 使用 Babel 汇编成为可能.

## 特征

-   全部提取 `enum`。 。 。 .
    -   从命名空间和集合名称中删除 。 (用帕斯卡语)
    -   替换 `interface` 与 `enum`。 。 。 .
-   删除 `import * as $protobuf from "protobufjs";`。 。 。 .
    -   保持小的捆绑大小.
-   删除全部 `Long`,无能,和可选.
-   删除全部 `class`。 。 。 .
-   删除所有函数声明类型的别名.
-   添加 `export` 关键词到 `interface` 内 `namespace`。 。 。 .

## 安装

```bash
$ npm i -D @cats-oss/ts-proto-optimize
```

## 使用量

```bash
# Output to stdout
$ $(npm bin)/ts-proto-optimize path/to/proto.d.ts

# Output to file
$ $(npm bin)/ts-proto-optimize path/to/proto.d.ts --output dist/to/proto.ts
```

### 示例

**输入 :**

```typescript
import * as $protobuf from 'protobufjs';

/** Namespace root. */
export namespace root {
  /** Namespace api. */
  namespace api {
    /** Properties of a Foo */
    interface IFoo {
      /** Foo str */
      str?: string | null;

      /** Foo number */
      num?: number | Long | null;
    }

    /** class Enumerate */
    class Foo implements IFoo {
      /**
       * comment
       */
      constructor(properties?: root.api.IFoo);

      /** comment */
      public str: string;

      /** comment */
      public num: number;
    }

    /** Enum enum */
    enum Enum {
      KEY1_SNAKE_CASE = 0,
      KEY2_SNAKE_CASE = 1,
      KEY3_SNAKE_CASE = 2,
    }

    namespace Nest {
      /**
       * Callback as used by {@link ...}.
       * @param error Error, if any
       * @param [response] GetFooResponse
       */
      type GetFooCallback = (
        error: Error | null,
        response?: root.api.GetFooResponse,
      ) => void;

      /** Enum enum. */
      enum Enum {
        KEY1 = 0,
        KEY2 = 1,
        KEY3 = 2,
      }

      /** Properties Data */
      interface IData {
        name?: string | null;
        value?: number | null;
        field?: root.api.Nest.IData | null;
        enumratee?: root.api.Nest.Enum | null;
      }

      /** Represents Data */
      class Data implements IData {
        constructor(properties?: root.api.Nest.IData);
      }
    }
  }
}
```

**输出 :**

```typescript
/** Namespace root. */
export declare namespace root {
  /** Namespace api. */
  export namespace api {
    /** Properties of a Foo */
    export interface IFoo {
      /** Foo str */
      str: string;
      /** Foo number */
      num: number;
    }
    export namespace Nest {
      /** Properties Data */
      export interface IData {
        name: string;
        value: number;
        field: root.api.Nest.IData;
        enumratee: RootApiNestEnum;
      }
    }
  }
}
export enum RootApiEnum {
  KEY1_SNAKE_CASE = 0,
  KEY2_SNAKE_CASE = 1,
  KEY3_SNAKE_CASE = 2,
}
export enum RootApiNestEnum {
  KEY1 = 0,
  KEY2 = 1,
  KEY3 = 2,
}
```

## 许可证

[MIT 网络代理公司](https://npmcn.com/package/%40cats-oss/ts-proto-optimize/LICENSE)

## 常见问题

### @cats-oss/ts-proto-optimize 是什么？

它是用于优化TypeScript protobuf类型定义文件的CLI工具\.

### 如何安装 @cats-oss/ts-proto-optimize？

在项目目录运行 npm install @cats-oss/ts-proto-optimize，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ts-proto-optimize，可以用 npx ts-proto-optimize 直接运行。

### @cats-oss/ts-proto-optimize 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cats-oss\_\_ts-proto-optimize 是否存在。

### @cats-oss/ts-proto-optimize 可以商用吗？

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

### @cats-oss/ts-proto-optimize 的下载量有多少？

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

### @cats-oss/ts-proto-optimize 还在维护吗？

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