@gmod/bgzf-filehandle

中文文档
6.8.5发布于 2026/11/16MITTypeScriptESM + CJS构建来源已验证近 30 天下载 10万

从压缩的 bgzip 文件( 有. gzi) 读取, 如未压缩

中文使用文档
文档目录7 节
  1. 安装
  2. Bgzf Filehandle (英语)
  3. 调色调
  4. unzipChunk 切片
  5. 文档
  6. 学术用途
  7. 许可证

@gmod/bgzf- filehandle (英语)

NPM version Build Status

读取 块- gzip (BGZF) 使用 未压缩坐标. 翻译:, (中文(简体) ), @gmod/tabix (英语) 财务报告和审定财务报表 @gmod/indexedfasta (英语) 以它为基础.

  • 在: bgzip 文件及其内容 .gzi 指数,或 BAI/TBI 指数的块
  • 输出 : 解压字节
  • 充气装置 无罪释放 编译为 Web Assembly)和内嵌为基数64,所以没有 .wasm 要服务的文件 。 打开 这个雷波的固定装置 它运行速度比帕克快2 -3x (单位:千美元)基准(中文(简体) )

安装

npm install @gmod/bgzf-filehandle

Bgzf Filehandle (英语)

import { BgzfFilehandle } from '@gmod/bgzf-filehandle'
import { LocalFile } from 'generic-filehandle2'

const f = new BgzfFilehandle({
  filehandle: new LocalFile('my_file.gz'),
  gziFilehandle: new LocalFile('my_file.gz.gzi'),
})

const data = await f.read(300, 0) // length, position

创建索引 bgzip -i my_file,或 bgzip -r my_file.gz 用于 已有文件。 对于远程文件,请将其包入 @gmod/range-cache-filehandle。 。 。 .

调色调

解压缩 BGZF 或平方 gzip 缓冲 :

import { unzip } from '@gmod/bgzf-filehandle'

const decompressed = await unzip(compressedData)

unzipChunk 切片

解压缩块 {minv, maxv} 取自 BAI 或 TBI 指数,每端为 a 页:1 {blockPosition, dataPosition}数字 :

import { MAX_BGZF_BLOCK_SIZE, unzipChunkSlice } from '@gmod/bgzf-filehandle'

// read one max-size block past maxv, since nothing records that block's length
const compressedData = await filehandle.read(
  maxv.blockPosition + MAX_BGZF_BLOCK_SIZE - minv.blockPosition,
  minv.blockPosition,
)
const { buffer, cpositions, dpositions } = await unzipChunkSlice(
  compressedData,
  { minv, maxv },
)

cpositions 财务报告和审定财务报表 dpositions 持有块边界,用于构建特性标识 保持稳定 跨越块.

第三个论点将块块分散在网络工人之间,这就使得 多兆字节块 1.1-2.0x 更快 (单位:千美元)医生/工人库:

import { getSharedWorkerPool } from '@gmod/bgzf-filehandle'

const pool = await getSharedWorkerPool() // undefined without Worker support
const result = await unzipChunkSlice(compressedData, { minv, maxv }, pool)

unzipChunkSegments 将相同的参数并跳过最后副本为一 缓冲器,用于可以分解分界的读取器 (单位:千美元)医生/工人库) (中文(简体) ).

文档

学术用途

写为 (原始内容存档于2018-09-21) (韩语). NHGRI 供资,作为 J 浏览如果您在出版物中使用,请引用 最近JBrowse的论文 jbrowse.org (英语)。 。 。 .

许可证

麻省理工学院 罗伯特·布厄尔斯, (中文(简体) ), 科林·迪什(签名)

版本与发布记录

@gmod/bgzf-filehandle 共发布 79 个版本,首次发布于 2018/08/23;过去 12 个月发布了 41 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.8.5latest2026/11/161 天前
6.8.42026/10/3117 天前
6.8.32026/10/3017 天前
6.8.22026/10/1730 天前
6.8.12026/10/1730 天前
6.8.02026/10/151 个月前

关于 @gmod/bgzf-filehandle 的常见问题

@gmod/bgzf-filehandle 是什么?

从压缩的 bgzip 文件( 有. gzi) 读取, 如未压缩

如何安装 @gmod/bgzf-filehandle?

在项目目录运行 npm install @gmod/bgzf-filehandle,或使用 pnpm add / yarn add / bun add。

@gmod/bgzf-filehandle 支持 TypeScript 吗?

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

@gmod/bgzf-filehandle 支持 ESM 还是 CommonJS?

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

@gmod/bgzf-filehandle 可以商用吗?

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

@gmod/bgzf-filehandle 的下载量有多少?

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

@gmod/bgzf-filehandle 还在维护吗?

最新版本 6.8.5 发布于 2026/11/16(1 天前);至今共发布 79 个版本,其中过去 12 个月发布了 41 个;首次发布于 2018/08/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。