@gmod/twobit

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

在节点或网络包中读取 2bit 文件

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

@ gmod/ 二位

NPM version Build Status

以 Node.js 或浏览器读取 2bit 序列文件 .

安装

$ npm install @gmod/twobit

使用量

import { TwoBitFile } from '@gmod/twobit'

const t = new TwoBitFile({ path: 'path/to/file.2bit' })

// coordinates are 0-based half-open
await t.getSequence('chr1', 0, 10) // first 10 bases
await t.getSequence('chr1') // whole sequence
await t.getSequenceNames() // ['chr1', ...]
await t.getSequenceSizes() // { chr1: length, ... }
await t.getSequenceSize('chr1')

在浏览器中,或对于HTTP上的文件,通过一个 filehandle 从 generic-filehandle2 而不是一个 path数字 :

import { RemoteFile } from 'generic-filehandle2'

const t = new TwoBitFile({
  filehandle: new RemoteFile('https://example.com/file.2bit'),
})

读取一个序列需要四个读取: 记录头及其两个块 表格,共32个字节,每读一个字节 序列,然后打包的基地。 超过HTTP,每轮4次往返 序列,所以一个字节距缓存,例如 @gmod/range-cache-filehandle 是一种便宜的交换 RemoteFile它能读出256个基B块 所以 标题读取来自记忆 后第一个和相邻序列 共享请求。 指数读取一次, 以块大小表示 序列名称,所以一个脚手架级的集合 与数十万 序列需要几兆字节, 而不是读取最长名称的大小 格式允许.

返回的序列保存文件的编码: 软块小写 基础, N编号 :n 对于模棱两可的人.

见 文件/附录 用于完整的API参考.

学术用途

这一一揽子计划是利用来自 (原始内容存档于2018-09-21) (韩语). NHGRI 作为《京都议定书》 J 浏览 项目。 如果您在所发表的学术项目中使用,请引用最新的JBrowse论文 jbrowse.org (英语)。 。 。 .

捐款

见 捐款额 用于开发和发布工作流程.

许可证

麻省理工学院 罗伯特·布厄尔斯

版本与发布记录

@gmod/twobit 共发布 38 个版本,首次发布于 2018/07/26;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.0.14latest2026/10/121 个月前
6.0.132026/10/081 个月前
6.0.122026/08/113 个月前
6.0.112026/08/013 个月前
6.0.102026/07/253 个月前
6.0.92026/05/195 个月前

关于 @gmod/twobit 的常见问题

@gmod/twobit 是什么?

在节点或网络包中读取 2bit 文件

如何安装 @gmod/twobit?

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

@gmod/twobit 支持 TypeScript 吗?

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

@gmod/twobit 支持 ESM 还是 CommonJS?

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

@gmod/twobit 可以商用吗?

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

@gmod/twobit 的下载量有多少?

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

@gmod/twobit 还在维护吗?

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