# @gmod/twobit 中文文档

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

版本：6\.0\.14
npm 元数据更新时间：2026-10-11T16:13:07.649Z
中文译文更新时间：2026-11-16T17:08:36.140Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：63.7 kB，18 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2018-07-26T04:00:55.257Z
- 最新版本发布：2026-10-11T16:13:07.302Z
- 近 30 天下载量：33845（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 12 个）

## 中文简介

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

## 安装

```sh
npm install @gmod/twobit
```

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

## README

# @ gmod/ 二位

[![NPM version](https://img.shields.io/npm/v/@gmod/twobit.svg?style=flat-square)](https://npmjs.org/package/@gmod/twobit) ![Build Status](https://img.shields.io/github/actions/workflow/status/GMOD/twobit-js/publish.yml?branch=main)

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

## 安装

```
$ npm install @gmod/twobit
```

## 使用量

```js
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`](https://www.npmjs.com/package/generic-filehandle2) 而不是一个 `path`数字 :

```js
import { RemoteFile } from 'generic-filehandle2'

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

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

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

见 [文件/附录](https://npmcn.com/package/%40gmod/twobit/docs/api.md) 用于完整的API参考.

## 学术用途

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

## 捐款

见 [捐款额](https://npmcn.com/package/%40gmod/twobit/CONTRIBUTING.md) 用于开发和发布工作流程.

## 许可证

麻省理工学院 [罗伯特·布厄尔斯](https://github.com/rbuels)

## 常见问题

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

