@gmod/nclist

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

从 JBrowse 1 格式嵌入封装列表读取特性 JSON

中文使用文档
文档目录5 节
  1. 状态
  2. 使用量
  3. API 密码
  4. 国家数据库
  5. 出版

数字列表-js

阅读遗产JBrowse 1嵌入式封装列表JSON.

状态

Build Status Coverage Status NPM version

使用量

import { RemoteFile } from 'generic-filehandle2'
import NCList from '@gmod/nclist'
;(async () => {
  const store = new NCList({
    baseUrl: `http://my.server/path/to/data/dir/`,
    urlTemplate: 'volvox_genes/{refseq}/trackData.json',
    readFile: url => new RemoteFile(url).readFile(),
  })

  for await (const feature of store.getFeatures({
    refName: 'ctgA',
    start: 0,
    end: 50000,
  })) {
    console.log(
      `got feature at ${feature.get('seq_id')}:${feature.get(
        'start',
      )}-${feature.get('end')}`,
    )
  }
})()

API 密码

目录

国家数据库

使用 JSON 文件所保存的嵌入式封存列表的序列特性存储 读起来很懒.

参数

  • args 对象 构造器参数
    • args.baseUrl 字符串 用于解决相对 URL 的基础 URL
    • args.urlTemplate 字符串 每个参考序列的根文件的模板字符串。 参考文献 序列名称将插入此字符串 {refseq} 出现.
    • args.readFile 函数 函数用于远程读取 URL.
    • args.cacheSize (可选,默认) 10(中文(简体) )

获取区域特性

获取给定区域特性覆盖的已拆分数 .

参数
  • query 对象
    • query.refName 字符串 引用序列名称
    • query.start 编号 区域开始
    • query.end 编号 区域结束
    • query.numBins 编号 特性计数中想要的桶数
    • query.basesPerBin 编号 每个功能计数框中想要的 bp 数

回返 对象 作为: { bins: hist, stats: statEntry }

获取形状

在指定区域获取特性 。 这个方法是同步生成器 生成特性对象.

参数
  • args 对象
    • args.refName 字符串 引用序列名称
    • args.start 编号 区域开始。 0基半开.
    • args.end 编号 区域结束。 0基半开.

出版

受托出版 通过 GitHub 行动.

pnpm version patch  # or minor/major

版本与发布记录

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

版本发布日期距今
3.0.15latest2026/10/091 个月前
3.0.142026/08/222 个月前
3.0.132026/08/113 个月前
3.0.122026/08/113 个月前
3.0.112026/07/253 个月前
3.0.102026/05/195 个月前

关于 @gmod/nclist 的常见问题

@gmod/nclist 是什么?

从 JBrowse 1 格式嵌入封装列表读取特性 JSON

如何安装 @gmod/nclist?

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

@gmod/nclist 支持 TypeScript 吗?

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

@gmod/nclist 支持 ESM 还是 CommonJS?

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

@gmod/nclist 可以商用吗?

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

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

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

@gmod/nclist 还在维护吗?

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