# @cparra/apex-reflection 中文文档

规范地址：https://npmcn.com/package/%40cparra/apex-reflection/

版本：4\.0\.0
npm 元数据更新时间：2026-07-05T15:23:00.861Z
中文译文更新时间：2026-11-10T21:23:25.948Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40cparra/apex-reflection
原文对照：https://npmcn.com/package/%40cparra/apex-reflection/?lang=original

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

- 包体积（解压后）：163 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- 首次发布：2021-09-27T22:40:10.458Z
- 最新版本发布：2026-07-05T15:23:00.750Z
- 近 30 天下载量：40023（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 39 个）

## 中文简介

提供反映Apex代码的工具,即"销售力量"开发中使用的语言.

## 安装

```sh
npm install @cparra/apex-reflection
```

也可以使用：`pnpm add @cparra/apex-reflection`、`yarn add @cparra/apex-reflection`、`bun add @cparra/apex-reflection`

## README

# 顶端反射

为Apex编程语言提供基本反射.

## 安装

```
npm i @cparra/apex-reflection
```

## 使用量

此库显示一个处理解析顶级类型( 类、 界面, 或) 的函数 enum)并返回结果.

```typescript
import { reflect } from "@cparra/apex-reflection";

const classBody = "public with sharing class ExampleClass {}";
const response = reflect(classBody);
```

如果您想要解析来自文件的 Apex 类型, 您可以读取文件内容, 并将它用作源 反映

```typescript
import * as fs from 'fs';
import {reflect} from '@cparra/apex-reflection';

const path = './MyClass.cls';
const rawFile = fs.readFileSync(path);
const response = reflect(rawFile.toString());
```

这个 `reflect` 函数返回 a `ReflectionResult` 包含解析结果 `Type` (将是一个 `ClassMirror`,一个 `InterfaceMirror`,或一个 `EnumMirror`或一个 `ParsingError` 如果传入 未成功解析正文,并有信件显示出错地点.

## 捐款

尽管这个库作为Node.js库被曝光,项目源代码还是用达特来写. 源头可以 可见于 `lib/src` 存储器目录 .

这个软件包将编译成一个WebAssembly(`dist/node.wasm`及其联合来文装载机 (单位:千美元)`dist/node.mjs`),由薄薄的TypeScript包装器以懒散方式装入 `index.mts`需要22个节点或更新( 模块使用WasmGC). 要在更改 Dart 源码后重建模块, 从寄存器根运行 :

```shell
dart compile wasm lib/src/node/node.dart -o js/node.wasm
```

`npm run build` 编译 TypeScript 包装器, 并复制主题模块及其加载器 `dist/`。 。 。 .

### 测试

必须测试达特源代码和被包装的WebAssembly模块.

达特测试在仓库里直播 `test` 目录。 Dart 源代码必须进行单位测试 单个 Dart 文件以及验证总体剖析功能的端到端测试.

联合来文的测试情况 `__tests__`。这些是针对已建套件的端到端测试(`dist/`因此他们 也防止出版一部烂的网络大会文物。 跟着他们跑 `npm test`。 。 。 .

### JSON 序列化

反射行动输出了JSON的顶级代表,然后在JS方面将其取消为 返回已键入对象.

序列化是通过 [连续大小](https://pub.dev/packages/json_serializable) 软件包,哪个 帮助自动创建来回代码,用于串行和去串行.

在修改任何带有序列化支持的模型类时, 要重建序列化代码运行

```shell
dart run build_runner build
```

### 分析

手写解析 [皮条客](https://pub.dev/packages/petitparser) 语法. Apex 语法仅解析了反射所需的声明结构( 机构被跳出为 均衡块),而Apexdoc语法则由它组成,因此doc的评论在同一个单行道中解析. 见 详细内容的存储器 README.

## 字体

这个库提供了自己的TS类型定义.

## 常见问题

### @cparra/apex-reflection 是什么？

提供反映Apex代码的工具,即"销售力量"开发中使用的语言\.

### 如何安装 @cparra/apex-reflection？

在项目目录运行 npm install @cparra/apex-reflection，或使用 pnpm add / yarn add / bun add。

### @cparra/apex-reflection 支持 TypeScript 吗？

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

### @cparra/apex-reflection 支持 ESM 还是 CommonJS？

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

### @cparra/apex-reflection 需要什么版本的 Node\.js？

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

### @cparra/apex-reflection 可以商用吗？

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

### @cparra/apex-reflection 的下载量有多少？

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

### @cparra/apex-reflection 还在维护吗？

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