# @carisls/xmlreport-reader 中文文档

规范地址：https://npmcn.com/package/%40carisls/xmlreport-reader/

版本：0\.9\.3
npm 元数据更新时间：2024-04-12T20:24:09.091Z
中文译文更新时间：2026-11-09T18:33:55.678Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：22.7 kB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2021-07-11T20:18:31.804Z
- 最新版本发布：2024-04-12T20:24:08.864Z
- 近 30 天下载量：1911（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 0 个）

## 中文简介

Caris XML 报告阅读组件

## 安装

```sh
npm install @carisls/xmlreport-reader
```

也可以使用：`pnpm add @carisls/xmlreport-reader`、`yarn add @carisls/xmlreport-reader`、`bun add @carisls/xmlreport-reader`

## README

# XML 报告阅读器

[![NPM Version](https://img.shields.io/npm/v/@carisls/xmlreport-reader.svg?style=flat)](https://www.npmjs.org/package/@carisls/xmlreport-reader) [![NPM Downloads](https://img.shields.io/npm/dm/@carisls/xmlreport-reader.svg?style=flat)](https://npmcharts.com/compare/@carisls/xmlreport-reader?minimal=true) [![Install Size](https://packagephobia.now.sh/badge?p=%40carisls%2Fxmlreport-reader)](https://packagephobia.now.sh/result?p=%40carisls%2Fxmlreport-reader)

这个组件的目的是用基因组学数据读取标准 XML 文档 由卡里斯生命科学公司创建.

它可以从Node.js应用程序内部使用 [API 密码](https://npmcn.com/package/%40carisls/xmlreport-reader/#readme-api-usage) 或作为可执行文件 [国 际](https://npmcn.com/package/%40carisls/xmlreport-reader/#readme-cli-usage)。 。 。 .

## 安装

```sh
npm i @carisls/xmlreport-reader
```

如果您想要在全球范围使用( 不仅在应用程序文件夹内) , 您可以 装入 `-g` 旗帜.

```sh
npm i -g @carisls/xmlreport-reader
```

## API 使用量

```javascript
const xmlReader = require('@carisls/xmlreport-reader');

const { promises: fs } = require('fs');

(async() => {
  // Get XML file contents
  const fileContents = await fs.readFile('./myfile.xml', 'utf8');

  // Parse XML into Report
  const report = xmlReader(fileContents);

  // Prettify report JSON
  const reportString = JSON.stringify(report, null, 2);

  // Write to console
  console.log(reportString);

})()
  .catch((err) => {
    console.error(err);
  });

```

## CLI 使用量

此组件也可以作为CLI运行(在应用程序之外).

```sh
xmlreport file.xml
```

如果您想要将其输出打印到某些文件中, 您可以执行

```sh
xmlreport file.xml > output.json
```

## 支助要素

目前支持提取的元素很少:

-   癌症相关生物标志
-   基因组签名
-   免疫组织化学
-   人类Leukocyte抗原(HLA)
-   现有的临床试验
-   参考资料(辅助治疗)

## 常见问题

### @carisls/xmlreport-reader 是什么？

Caris XML 报告阅读组件

### 如何安装 @carisls/xmlreport-reader？

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

### @carisls/xmlreport-reader 支持 TypeScript 吗？

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

### @carisls/xmlreport-reader 支持 ESM 还是 CommonJS？

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

### @carisls/xmlreport-reader 可以商用吗？

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

### @carisls/xmlreport-reader 的下载量有多少？

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

### @carisls/xmlreport-reader 还在维护吗？

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