@gmod/trix

中文文档
3.2.3发布于 2026/11/16Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 3.1万

读取 UCSC 纯 Java 脚本中的 Trix 索引

中文使用文档
文档目录7 节
  1. 安装
  2. 使用量
  3. API 密码
  4. new Trix(ixxFile, ixFile, maxResults?)
  5. trix.search(searchString, opts?)
  6. 读取 HTTP
  7. 参考文献

Build Status

三进制

读取 UCSC 纯 Java 脚本中的 Trix 索引

安装

npm install @gmod/trix

使用量

import Trix from '@gmod/trix'
import { RemoteFile } from 'generic-filehandle2'

// generic-filehandle2 also has LocalFile for files on disk
const trix = new Trix(
  new RemoteFile('https://jbrowse.org/genomes/GRCh38/trix/hg38.ixx'),
  new RemoteFile('https://jbrowse.org/genomes/GRCh38/trix/hg38.ix'),
)

const results = await trix.search('oca')
// => [[term, record], ...]

API 密码

new Trix(ixxFile, ixFile, maxResults?)

  • ixxFile - 处理文件 .ixx 文件
  • ixFile - 处理文件 .ix 文件
  • maxResults - 多数结果为搜索返回,默认为20。 也摆放 之后作为 trix.maxResults

任何对象 read(length, position, opts?) 决 议 Uint8Array 财务报告和审定财务报表 readFile({ encoding: 'utf8' }) 解析到字符串工作,其中包括 每个 generic-filehandle2 手柄。 导出 Filehandle 类型描述它.

trix.search(searchString, opts?)

前缀搜索索引并解析到 [term, record][]时 term 实值 匹配和 record 这是它指出的关键。 记录为 重复了,所以两个词 在同一记录中产生一个结果.

  • searchString - 查询。 每个空白分隔的单词都是前缀搜索的 当每个字都发现它的时候,将依次归还一个记录。 一句话 最多200个记录(或 maxResults,如果 更多人无法排除记录: b brca2 答案为 页:1 brca2 记录
  • opts.signal - 一个 AbortSignal 以取消基础

读取 HTTP

搜索获取 .ixx 一次,然后读 .ix 从匹配的检查站,256 KiB先行 之后再翻两番 排字头连续按键 读取附近的相抵,所以 输入 spd_00 输入1.7 MB 测试指数后, 6 读取3个不同的 页:1 与 @gmod/range-cache-filehandle 在两个文件处理器下,4个256个基B块服务全部6个,并进行回放 不需要新获取 :

import { RemoteFileWithRangeCache } from '@gmod/range-cache-filehandle'

const trix = new Trix(
  new RemoteFileWithRangeCache(`${url}.ixx`),
  new RemoteFileWithRangeCache(`${url}.ix`),
)

参考文献

见 UCSC 三相文档 概念,和 ixxx-js (英语) (单位:千美元) Java 脚本执行 ixIxx 命令构建这些索引.

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

版本与发布记录

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

版本发布日期距今
3.2.3latest2026/11/16今天
3.2.22026/11/106 天前
3.2.12026/11/106 天前
3.2.02026/11/106 天前
3.1.02026/10/151 个月前
3.0.222026/08/153 个月前

关于 @gmod/trix 的常见问题

@gmod/trix 是什么?

读取 UCSC 纯 Java 脚本中的 Trix 索引

如何安装 @gmod/trix?

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

@gmod/trix 支持 TypeScript 吗?

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

@gmod/trix 支持 ESM 还是 CommonJS?

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

@gmod/trix 可以商用吗?

@gmod/trix 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

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

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

@gmod/trix 还在维护吗?

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