@chonkiejs/core

中文文档
0.0.12发布于 2026/10/04MITTypeScriptES Module构建来源已验证近 30 天下载 10.8万

Chonkie 核心块块库 - 轻量级和高效文本块

中文使用文档
文档目录7 节
  1. 特征
  2. 安装
  3. 快速启动
  4. 可用的弹簧器
  5. 捐款
  6. 鸣谢
  7. 引用

Chonkie Logo

@ chonkiejs/ 分数

用于Chonkie的核心块化库 - 轻量级和高效的文本块化,零依赖性.

npm version npm license Documentation GitHub

特征

✨ 简单清洁 API( C) - 易于使用OOP设计
⚡ 无依赖 - 最小,轻量级,快
🔤 基于字符 - 简单的符号化(1个字符=1个符号)
🎯 递归春金 智能的分层文本
📦 类型脚本第一 - 带有类型脚本的完整类型安全

安装

安装方式 npm数字 :

npm i @chonkiejs/core

安装方式 pnpm数字 :

pnpm add @chonkiejs/core

安装方式 yarn数字 :

yarn add @chonkiejs/core

安装方式 bun数字 :

bun add @chonkiejs/core

快速启动

import { RecursiveChunker } from '@chonkiejs/core';

// Create a chunker
const chunker = await RecursiveChunker.create({
  chunkSize: 512,
  minCharactersPerChunk: 24
});

// Chunk your text
const chunks = await chunker.chunk('Your text here...');

// Use the chunks
for (const chunk of chunks) {
  console.log(chunk.text);
  console.log(`Tokens: ${chunk.tokenCount}`);
}

可用的弹簧器

名称说明
RecursiveChunker以分级规则递相分出文本(第-段-句子-句子-句子-字符). 每个关卡只有在块超过所配置的大小时才会激活.
TokenChunker将文本分割成可选重叠的固定大小符号块。 默认情况下使用基于字符的符号化,或使用有@chonkiejs/token的HuggingFace模型.
TableChunker将 Markdown 或 HTML 表格拆分为更小的表格块,同时重复每个块中的原标题。 支持以行为基础的模式和以符号为基础的模式.
FastChunker以字节为基础的边界探测 @chonkiejs/chunk 用于非常快地用分界器或图案控件进行分块.

详细的API文档、配置选项和高级使用,参见 DOCS. md (英语)。 。 。 .

捐款

想帮忙种姜子吗? 检查出来 捐款额 开始吧! 无论是修复错误,添加特性,改进文件,还是简单地在回放上留下一个"Q",每一份贡献都有助于让Chonki成为每个人更好的CHONK.

记住:对于这个小河马来说,任何贡献都不算太小!

鸣谢

Chonkie想通过特别感谢所有用户和贡献者, 你的反馈,发布的报告, 和改进 帮助了姜琪 它可能是.

当然,特别感谢 摩托摩托语 赞美姜琪的名言:

"我喜欢他们大块头,我喜欢他们在TypeScript的chonkie" ~ Moto Moto..

引用

如果您在研究中使用Chonkie,请引用如下:

@software{chonkie2025,
  author = {Bhavnick Minhas and Shreyash Nigam},
  title = {Chonkie: A no-nonsense fast, lightweight, and efficient text chunking library},
  year = {2025},
  publisher = {GitHub},
  howpublished = {\url{https://github.com/chonkie-inc}},
}

版本与发布记录

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

版本发布日期距今
0.0.12latest2026/10/041 个月前
0.0.112026/06/194 个月前
0.0.102026/05/135 个月前
0.0.92026/03/287 个月前
0.0.82026/03/137 个月前
0.0.72026/01/219 个月前

关于 @chonkiejs/core 的常见问题

@chonkiejs/core 是什么?

Chonkie 核心块块库 - 轻量级和高效文本块

如何安装 @chonkiejs/core?

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

@chonkiejs/core 支持 TypeScript 吗?

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

@chonkiejs/core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@chonkiejs/core 可以商用吗?

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

@chonkiejs/core 的下载量有多少?

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

@chonkiejs/core 还在维护吗?

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