# @gmod/nclist 中文文档

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

版本：3\.0\.15
npm 元数据更新时间：2026-10-09T00:33:22.270Z
中文译文更新时间：2026-11-16T17:09:09.915Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：134 kB，46 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2019-04-20T19:36:44.601Z
- 最新版本发布：2026-10-09T00:33:21.740Z
- 近 30 天下载量：32340（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 10 个）

## 中文简介

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

## 安装

```sh
npm install @gmod/nclist
```

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

## README

# 数字列表-js

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

## 状态

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

## 使用量

```javascript
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 密码

#### 目录

-   [国家数据库](https://npmcn.com/package/%40gmod/nclist/#readme-ncliststore)
    -   [参数](https://npmcn.com/package/%40gmod/nclist/#readme-parameters)
    -   [获取区域特性](https://npmcn.com/package/%40gmod/nclist/#readme-getregionfeaturedensities)
        -   [参数](https://npmcn.com/package/%40gmod/nclist/#readme-parameters-1)
    -   [获取形状](https://npmcn.com/package/%40gmod/nclist/#readme-getfeatures)
        -   [参数](https://npmcn.com/package/%40gmod/nclist/#readme-parameters-2)

### 国家数据库

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

#### 参数

-   `args` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 构造器参数
    -   `args.baseUrl` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 用于解决相对 URL 的基础 URL
    -   `args.urlTemplate` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 每个参考序列的根文件的模板字符串。 参考文献 序列名称将插入此字符串 `{refseq}` 出现.
    -   `args.readFile` **[函数](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 函数用于远程读取 URL.
    -   `args.cacheSize` (可选,默认) `10`(中文(简体) )

#### 获取区域特性

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

##### 参数

-   `query` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `query.refName` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 引用序列名称
    -   `query.start` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 区域开始
    -   `query.end` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 区域结束
    -   `query.numBins` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 特性计数中想要的桶数
    -   `query.basesPerBin` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 每个功能计数框中想要的 bp 数

回返 **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 作为: `{ bins: hist, stats: statEntry }`

#### 获取形状

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

##### 参数

-   `args` **[对象](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `args.refName` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 引用序列名称
    -   `args.start` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 区域开始。 0基半开.
    -   `args.end` **[编号](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 区域结束。 0基半开.

## 出版

[受托出版](https://docs.npmjs.com/about-trusted-publishing) 通过 GitHub 行动.

```bash
pnpm version patch  # or minor/major
```

## 常见问题

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

