# @gmod/faidx 中文文档

规范地址：https://npmcn.com/package/%40gmod/faidx/

版本：3\.1\.0
npm 元数据更新时间：2026-11-15T14:41:10.708Z
中文译文更新时间：2026-11-16T17:11:33.994Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：30 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-11-03T13:55:00.164Z
- 最新版本发布：2026-11-15T14:41:10.371Z
- 近 30 天下载量：11743（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 4 个）

## 中文简介

创建索引快取文件

## 安装

```sh
npm install @gmod/faidx
```

也可以使用：`pnpm add @gmod/faidx`、`yarn add @gmod/faidx`、`bun add @gmod/faidx`

## README

![Build Status](https://img.shields.io/github/actions/workflow/status/GMOD/faidx-js/publish.yml?branch=main&logo=github&style=for-the-badge)

## 安装

```
$ npm install --save @gmod/faidx
```

## 使用量

`FastaIndexTransform` 是一个 `TransformStream<Uint8Array, string>` 转弯 FASTA字节入FAI指数行. 它扫描输入为字节,所以内存保留 平地,无论序列线长多少.

节点.js——将索引写入 a `.fai` 文件 :

```js
import { openAsBlob } from 'node:fs'
import { writeFile } from 'node:fs/promises'
import { FastaIndexTransform } from '@gmod/faidx'

const fasta = await openAsBlob('genome.fa')
await writeFile(
  'genome.fa.fai',
  fasta.stream().pipeThrough(new FastaIndexTransform()),
)
```

浏览器 — 从 a 获取 FAI 索引作为字符串 `File` 输入 :

```js
import { FastaIndexTransform } from '@gmod/faidx'

const fai = await new Response(
  file
    .stream()
    .pipeThrough(new FastaIndexTransform())
    .pipeThrough(new TextEncoderStream()),
).text()
```

套件还出口 `generateFastaIndex(writable, readable)`,哪些管道 a `ReadableStream<Uint8Array>` fASTA 改为 `WritableStream<Uint8Array>` 那个 获得编码索引。 过 `{ signal }` 作为取消的第三个参数:a 中止取消读取,中止可写入,并拒绝.

## 学术用途

这一一揽子计划是利用来自 [(原始内容存档于2018-09-21) (韩语). NHGRI](http://genome.gov/) 作为 页:1 [J 浏览](http://jbrowse.org/) 项目。 如果你在学术中使用它 请引用最近发表的JBrowse论文 链接从 [jbrowse.org (英语)](http://jbrowse.org/)。 。 。 .

## 许可证

麻省理工学院 [科林·迪什(签名)](https://github.com/cmdcolin)

## 捐款

见 [捐款额](https://npmcn.com/package/%40gmod/faidx/CONTRIBUTING.md) 为发展和释放步骤.

## 常见问题

### @gmod/faidx 是什么？

创建索引快取文件

### 如何安装 @gmod/faidx？

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

### @gmod/faidx 支持 TypeScript 吗？

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

### @gmod/faidx 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gmod/faidx 可以商用吗？

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

### @gmod/faidx 的下载量有多少？

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

### @gmod/faidx 还在维护吗？

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

