# @ardatan/grpc-reflection-js 中文文档

规范地址：https://npmcn.com/package/%40ardatan/grpc-reflection-js/

版本：0\.0\.2
npm 元数据更新时间：2022-07-19T16:50:38.076Z
中文译文更新时间：2026-11-06T18:05:29.321Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ardatan/grpc-reflection-js
原文对照：https://npmcn.com/package/%40ardatan/grpc-reflection-js/?lang=original
源码仓库：https://github.com/redhoyasa/grpc-reflection-js

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

- 包体积（解压后）：161 kB，28 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：protobufjs ^7\.0\.0，@grpc/grpc-js ^1\.0\.0
- 首次发布：2022-07-19T16:49:36.854Z
- 最新版本发布：2022-07-19T16:50:37.998Z
- 近 30 天下载量：10141（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

[![npm version](https://badge.fury.io/js/grpc-reflection-js.svg)](https://badge.fury.io/js/grpc-reflection-js) ![CI](https://github.com/redhoyasa/grpc-reflection-js/workflows/CI/badge.svg) \[代码cov\] ([https://codecov.io/gh/redhoyasa/grpc-reflection-js/bra. 页面存档备份,存于互联网档案馆](https://codecov.io/gh/redhoyasa/grpc-reflection-js/bra)

## 安装

```sh
npm install @ardatan/grpc-reflection-js
```

也可以使用：`pnpm add @ardatan/grpc-reflection-js`、`yarn add @ardatan/grpc-reflection-js`、`bun add @ardatan/grpc-reflection-js`

## README

# gRPC 反思联合来文

[![npm version](https://badge.fury.io/js/grpc-reflection-js.svg)](https://badge.fury.io/js/grpc-reflection-js) ![CI](https://github.com/redhoyasa/grpc-reflection-js/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/redhoyasa/grpc-reflection-js/branch/master/graph/badge.svg)](https://codecov.io/gh/redhoyasa/grpc-reflection-js)

与任何执行的gRPC 服务器交谈的联署材料库 [反思](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) 协议.

## 安装

用 npm 安装 :

```sh
npm install grpc-reflection-js @grpc/grpc-js
```

用纱线安装 :

```sh
yarn add grpc-reflection-js @grpc/grpc-js
```

## 使用量

-   [初始化客户端](https://npmcn.com/package/%40ardatan/grpc-reflection-js/#readme-Initialize)
-   [列表服务](https://npmcn.com/package/%40ardatan/grpc-reflection-js/#readme-listServices): 列出 gRPC 服务
-   [文件正在连接符号](https://npmcn.com/package/%40ardatan/grpc-reflection-js/#readme-fileContainingSymbol): 获取原生出 使用完全合格符号名的根
-   [文件名](https://npmcn.com/package/%40ardatan/grpc-reflection-js/#readme-fileByFilename): 获取原生出 使用 proto 文件名的根

### 初始化

```js
const grpc = require('grpc');
const grpcReflection = require('grpc-reflection-js');

const grpcReflectionServer = '<gRPC Reflection server host>'
const reflectionClient = new grpcReflection.Client(
  grpcReflectionServer,
  grpc.credentials.createInsecure()
);
```

### 列表服务

```js
const services = await reflectionClient.listServices()
```

产出

```text
['grpc.reflection.v1alpha.ServerReflection', 'phone.Messenger']
```

### 文件正在连接符号

```js
const root = await reflectionClient.fileContainingSymbol('phone.Messenger')
```

### 文件名

```js
const root = await reflectionClient.fileContainingSymbol('contact.proto')
```

## 许可证

[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg?maxAge=2592000)](https://raw.githubusercontent.com/apollostack/apollo-ios/master/LICENSE)

麻省理工学院

## 常见问题

### @ardatan/grpc-reflection-js 是什么？

\[代码cov\] \(https://codecov\.io/gh/redhoyasa/grpc-reflection-js/bra\. 页面存档备份,存于互联网档案馆

### 如何安装 @ardatan/grpc-reflection-js？

在项目目录运行 npm install @ardatan/grpc-reflection-js，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：protobufjs（^7\.0\.0）、@grpc/grpc-js（^1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @ardatan/grpc-reflection-js 支持 TypeScript 吗？

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

### @ardatan/grpc-reflection-js 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @ardatan/grpc-reflection-js 可以商用吗？

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

### @ardatan/grpc-reflection-js 的下载量有多少？

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

### @ardatan/grpc-reflection-js 还在维护吗？

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