# @chonkiejs/core 中文文档

规范地址：https://npmcn.com/package/%40chonkiejs/core/

版本：0\.0\.12
npm 元数据更新时间：2026-10-03T16:06:52.527Z
中文译文更新时间：2026-11-09T14:21:57.204Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40chonkiejs/core
原文对照：https://npmcn.com/package/%40chonkiejs/core/?lang=original
项目主页：https://docs.chonkie.ai/
源码仓库：https://github.com/feyninc/chonkiejs

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

- 包体积（解压后）：286 kB，90 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-10-08T02:31:40.969Z
- 最新版本发布：2026-10-03T16:06:52.179Z
- 近 30 天下载量：108049（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 6 个）

## 中文简介

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

## 安装

```sh
npm install @chonkiejs/core
```

也可以使用：`pnpm add @chonkiejs/core`、`yarn add @chonkiejs/core`、`bun add @chonkiejs/core`

## README

![Chonkie Logo](https://npmcn.com/package/assets/chonkie_logo_br_transparent_bg.png)

# @ chonkiejs/ 分数

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

[![npm version](https://img.shields.io/npm/v/@chonkiejs/core)](https://www.npmjs.com/package/@chonkiejs/core) [![npm license](https://img.shields.io/npm/l/@chonkiejs/core)](https://www.npmjs.com/package/@chonkiejs/core) [![Documentation](https://img.shields.io/badge/docs-DOCS.md-blue.svg)](https://npmcn.com/package/%40chonkiejs/core/DOCS.md) [![GitHub](https://img.shields.io/badge/github-chonkie--ts-black.svg?logo=github)](https://github.com/chonkie-inc/chonkiejs)

## 特征

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

## 安装

安装方式 `npm`数字 :

```bash
npm i @chonkiejs/core
```

安装方式 `pnpm`数字 :

```bash
pnpm add @chonkiejs/core
```

安装方式 `yarn`数字 :

```bash
yarn add @chonkiejs/core
```

安装方式 `bun`数字 :

```bash
bun add @chonkiejs/core
```

## 快速启动

```typescript
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 (英语)](https://npmcn.com/package/%40chonkiejs/core/DOCS.md)。 。 。 .

## 捐款

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

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

## 鸣谢

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

当然,特别感谢 [摩托摩托语](https://www.youtube.com/watch?v=I0zZC4wtqDQ&t=5s) 赞美姜琪的名言:

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

## 引用

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

```bibtex
@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 是什么？

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