# @counterrealist/simhash 中文文档

规范地址：https://npmcn.com/package/%40counterrealist/simhash/

版本：1\.0\.2
npm 元数据更新时间：2025-07-09T12:59:49.321Z
中文译文更新时间：2026-11-10T21:00:12.646Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40counterrealist/simhash
原文对照：https://npmcn.com/package/%40counterrealist/simhash/?lang=original
项目主页：https://github.com/counterrealist/simhash#readme
源码仓库：https://github.com/counterrealist/simhash

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

- 包体积（解压后）：32.9 kB，25 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-06-27T10:01:06.790Z
- 最新版本发布：2025-07-09T12:59:49.096Z
- 近 30 天下载量：7196（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

使用各种散列函数,如SipHash、MD5和SHA256探测近复制文本的Simhash执行

## 安装

```sh
npm install @counterrealist/simhash
```

也可以使用：`pnpm add @counterrealist/simhash`、`yarn add @counterrealist/simhash`、`bun add @counterrealist/simhash`

## README

# 西马什

_使用各种散列函数,如SipHash、MD5和SHA256探测近复制文本的Simhash执行_

## 安装

```bash
npm i @counterrealist/simhash
```

## 使用量

```typescript
import {SimHash, BitArray, HashFunction} from "@counterrealist/simhash"

const simHash = new SimHash({
    ngramSize: 3, // Default to 3
    hashFunction: HashFunction.SIPHASH // Default to SIPHASH, Options: SIPHASH, MD5, SHA256
});

const text1: string = "Hello, world!";
const text2: string = "Hell's world";

const text1_bitarray: BitArray = simHash.compute_bitarray(text1); // [0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 0, 0, ...]
const text1_buffer: Buffer = simHash.compute_buffer(text1); // <Buffer 5f 4c d1 d8 77 30 f4 e5 fd af ec b7 58 c7 9c 5b>
const text1_hex: string = simHash.compute_hex(text1); // 5f4cd1d87730f4e5fdafecb758c79c5b

const text2_bitarray: BitArray = simHash.compute_bitarray(text2); // [0, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, ...]
const text2_buffer: Buffer = simHash.compute_buffer(text2); // <Buffer 19 64 42 58 f7 48 04 e4 5d 03 0c 2f 50 d5 8e 4d>
const text2_hex: string = simHash.compute_hex(text2); // 19644258f74804e45d030c2f50d58e4d

const textSimilarity: number = simHash.similarity(text1, text2); // 0.6875
const textSimilarityFromHex: number = simHash.similarityFromHex(text1_hex, text2_hex); // 0.6875
const textSimilarityFromBuffers: number = simHash.similarityFromBuffers(text1_buffer, text2_buffer); // 0.6875
const textSimilarityFromBits: number = simHash.similarityFromBits(text1_bitarray, text2_bitarray); // 0.6875
```

### 实例

[@ 反现实主义者/ simhash- crawler- 实例](https://github.com/counterrealist/simhash-crawler-example) ——一个简单的机器人,计算维基文章的修订之间的相似性.

## 常见问题

### @counterrealist/simhash 是什么？

使用各种散列函数,如SipHash、MD5和SHA256探测近复制文本的Simhash执行

### 如何安装 @counterrealist/simhash？

在项目目录运行 npm install @counterrealist/simhash，或使用 pnpm add / yarn add / bun add。

### @counterrealist/simhash 支持 TypeScript 吗？

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

### @counterrealist/simhash 支持 ESM 还是 CommonJS？

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

### @counterrealist/simhash 可以商用吗？

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

### @counterrealist/simhash 的下载量有多少？

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

### @counterrealist/simhash 还在维护吗？

最新版本 1\.0\.2 发布于 2025/07/09（1\.3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/06/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。