@gmod/faidx

中文文档
3.1.0发布于 2026/11/15MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 1.2万

创建索引快取文件

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 学术用途
  4. 许可证
  5. 捐款

Build Status

安装

$ npm install --save @gmod/faidx

使用量

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

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

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 输入 :

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 作为 页:1 J 浏览 项目。 如果你在学术中使用它 请引用最近发表的JBrowse论文 链接从 jbrowse.org (英语)。 。 。 .

许可证

麻省理工学院 科林·迪什(签名)

捐款

见 捐款额 为发展和释放步骤.

版本与发布记录

@gmod/faidx 共发布 14 个版本,首次发布于 2021/11/03;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.1.0latest2026/11/151 天前
3.0.12026/08/113 个月前
3.0.02026/08/013 个月前
2.0.52026/07/263 个月前
2.0.02025/11/041 年前
1.0.72025/10/091.1 年前

关于 @gmod/faidx 的常见问题

@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 和提交记录判断。