@gmod/gff-nostream

中文文档
5.6.6发布于 2026/11/16MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 1.3万

读取 GFF3 数据的公用事业

中文使用文档
文档目录12 节
  1. 安装
  2. 使用量
  3. 对象格式
  4. 分析行为
  5. 多地点特性
  6. 懒惰分析
  7. API 密码
  8. 分析
  9. 属性
  10. 其它
  11. 类型
  12. 捐款

@gmod/gff-nostream (英语)

NPM version Build Status

解析 GFF3 数据,作为简化版本 @gmod/gff (英语) 没有节点.js流依赖.

安装

pnpm add @gmod/gff-nostream

使用量

import { readFileSync } from 'node:fs'
import { parseStringSync } from '@gmod/gff-nostream'

const features = parseStringSync(readFileSync('my_annotations.gff3', 'utf8'))

在浏览器中,通过任何 GFF3 字符串,例如来自 fetch(…).then(r => r.text())用于远程 .gff3.gz,以 @gmod/tabix (英语) 然后将返回的行传给 parseLines。 。 。 .

对象格式

  • 坐标为0相半开.
  • strand 是数字( e)1编号 :-1编号 :0) (中文(简体) ).
  • 属性变为小写顶级密钥, 当 单值.
  • 儿童特征 subfeatures。 。 。 .
{
  "refName": "ctg123",
  "source": null,
  "type": "gene",
  "start": 999,
  "end": 9000,
  "strand": 1,
  "subfeatures": [
    {
      "refName": "ctg123",
      "source": null,
      "type": "mRNA",
      "start": 1049,
      "end": 9000,
      "strand": 1,
      "subfeatures": [],
      "id": "mRNA00001",
      "parent": "gene00001",
      "name": "EDEN.1"
    }
  ],
  "id": "gene00001",
  "name": "EDEN"
}

解析器附件 2 到一个小写名称与固定名称相匹配的属性 字段 (refName, (中文(简体) ), source, (中文(简体) ), type, (中文(简体) ), start, (中文(简体) ), end, (中文(简体) ), score, (中文(简体) ), strand, (中文(简体) ), phase, (中文(简体) ), subfeatures, (中文(简体) ), seq_id, (中文(简体) ), refname),这样 Start= 变成 start2。 。 。 .

分析行为

  • 解析器忽略了评论,指令,和 ##FASTA 节.
  • 解析器裁剪了属性标记周围的空格, 所以 Name=A; ID=x 有一个 ID。 。 。 .
  • 一个特征,它的 Parent 在输入中缺失, 如 tabix 查询切换 离开母行,回来作为顶级功能.

多地点特性

多位置特性在多行有相同的ID, 如 CDS 横跨多段.

  • 没有父母,第一行就变成了一个贯穿每个部分的特征, 将每个部分作为同一类型的子特征。 一个NCBI cDNA_match 来了 这边走.
  • 与父关系,每行在其下保留一个单独的特征,如同 多出类拔萃 CDS. 解析器仍然合并了另一个行名作为它的 ID 父公司,如已成熟的 NCBI 帧转换 CDS(SARS-CoV-2 ORF1ab) 其下有脓.
  • 类型不同或第一行已有子女的行,请留下 单独的重复.

懒惰分析

每个剖面函数都有 …Lazy 将第9栏作为原始文本的对等文本 打开 feature.attributeString 而不是把它传播到键上。 它只读 ID 财务报告和审定财务报表 Parent因为它没有它们就无法建立这棵树.

import { getAttribute, parseLinesLazy } from '@gmod/gff-nostream'

const features = parseLinesLazy(lines)
const names = features.map(f => getAttribute(f, 'name'))

懒惰的解析只有在大多数属性不读时才有回报,因为每个属性 getAttribute 重新扫描字符串。 见 医生/懒惰者。 。 。 .

API 密码

分析

parseStringSync(str: string): GffFeature[]

分析一个 GFF3 字符串 .

parseLines(lines: readonly string[]): GffFeature[]

解析 GFF3 特性行, 如 Tabix 查询返回 。 线条必须包含 无空白、注释或 ##FASTA 节.

parseRecords<R extends LineRecord>(records: readonly R[]): ParsedRecord<R>[]

解析一系列记录来包装原始 GFF3 行 .

解析器配对每个顶级特性及其源记录, 额外字段 包括,所以一个呼叫者可以 附加自己的稳定身份.

const records = lines.map((line, i) => ({ line, offset: offsets[i] }))
const features = parseRecords(records).map(({ feature, record }) => ({
  ...feature,
  id: record.offset,
}))

parseLinesLazy 编号 : parseRecordsLazy

喜欢 parseLines 财务报告和审定财务报表 parseRecords返回时 LazyGffFeatures. 见 懒惰分析。 。 。 .

parseFeatureLazy(line: string): LazyGffFeature

分出一行,无树楼.

属性

getAttribute(feature: LazyGffFeature, key: string): unknown

其解析出的一个属性(小于, 2- 保留后缀) 形状为急切的剖析器生成.

getAttributes(feature: LazyGffFeature): Record<string, unknown>

每一个属性,像渴望的解析器会传播它们.

getLinkAttributes(feature: LazyGffFeature): { id: unknown; parent: unknown }

ID 财务报告和审定财务报表 Parent 在一个通行证, 给打电话的人做自己的联系.

其它

extractType(line: string): string

生线的特征类型(第3栏),或 '' 以小于 两个标签.

hasIdAttribute(line: string): boolean

原始线条是否有 ID 解析器将儿童与 解析器自己的标签扫描.

类型

interface LineRecord {
  line: string
}

interface ParsedRecord<R extends LineRecord = LineRecord> {
  feature: GffFeature
  record: R
}

ParsedLazyRecord 实值 ParsedRecord 带有 LazyGffFeature。 。 。 .

捐款

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

版本与发布记录

@gmod/gff-nostream 共发布 8 个版本,首次发布于 2026/10/08;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.6.6latest2026/11/16今天
5.6.52026/11/161 天前
5.6.42026/10/3017 天前
5.6.32026/10/3017 天前
5.6.22026/10/151 个月前
5.6.12026/10/081 个月前

关于 @gmod/gff-nostream 的常见问题

@gmod/gff-nostream 是什么?

读取 GFF3 数据的公用事业

如何安装 @gmod/gff-nostream?

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

@gmod/gff-nostream 支持 TypeScript 吗?

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

@gmod/gff-nostream 支持 ESM 还是 CommonJS?

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

@gmod/gff-nostream 可以商用吗?

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

@gmod/gff-nostream 的下载量有多少?

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

@gmod/gff-nostream 还在维护吗?

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