# myers

**Repository Path**: nodets/myers

## Basic Information

- **Project Name**: myers
- **Description**: 一个高性能的TypeScript差异计算库，基于Myers算法实现，用于高效计算两个序列之间的差异。该库兼顾了极致性能与类型安全，适用于需要处理大量数据对比的场景。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-04
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# myers

一个高性能的TypeScript差异计算库，基于Myers算法实现，用于高效计算两个序列之间的差异。该库兼顾了极致性能与类型安全，适用于需要处理大量数据对比的场景。

## 特性

- **高性能**：相比传统实现平均快7.5倍，针对大型数据集进行了特别优化
- **类型安全**：完全用TypeScript编写，提供完善的类型定义
- **多数据类型支持**：支持字符串、数字、对象等各种数据类型的对比
- **自定义相等性检查**：允许用户提供自定义的相等性比较函数
- **并发安全**：使用线程局部存储替代全局缓冲区，避免并发冲突
- **边缘情况处理**：妥善处理空序列、完全相同序列等特殊情况

## 安装

```bash
npm install myers
# 或
yarn add myers
```

## 基本使用

```typescript
import { diff } from 'myers';

// 简单数组对比
const a = [1, 2, 3, 4, 5];
const b = [2, 3, 4, 5, 6];
const differences = diff(a, b);

console.log(differences);
// 输出:
// [
//   { t: 2, v: 1 },  // 删除1
//   { t: 0, v: 2 },  // 保持2
//   { t: 0, v: 3 },  // 保持3
//   { t: 0, v: 4 },  // 保持4
//   { t: 0, v: 5 },  // 保持5
//   { t: 1, v: 6 }   // 插入6
// ]
```

## 自定义相等性检查

对于复杂对象，你可以提供自定义的相等性检查函数：

```typescript
import { diff } from 'myers';

const a = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
const b = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Robert' }];

// 基于id进行比较
const differences = diff(a, b, (x, y) => x.id === y.id);

console.log(differences);
// 输出:
// [
//   { t: 0, v: { id: 1, name: 'Alice' } },
//   { t: 2, v: { id: 2, name: 'Bob' } },
//   { t: 1, v: { id: 2, name: 'Robert' } }
// ]
```

## API 文档

### `diff<T>(a: T[], b: T[], eq?: (x: T, y: T) => boolean): DiffOp<T>[]`

计算两个数组之间的差异。

- **参数**：
  - `a`: 原始数组
  - `b`: 目标数组
  - `eq` (可选): 自定义相等性检查函数，默认为内部实现的安全相等性检查

- **返回值**：
  差异操作数组，每个操作是以下类型之一：
  - `{ t: 0, v: T }`: 两个数组中都存在的元素（相等）
  - `{ t: 1, v: T }`: 插入操作（在`b`中存在，`a`中不存在）
  - `{ t: 2, v: T }`: 删除操作（在`a`中存在，`b`中不存在）

## 性能表现

在标准测试环境（Intel Core i9-12900K, 64GB内存）下的性能对比：

| 数据规模 | 传统Myers实现(ms) | 本库实现(ms) | 性能提升 |
|---------|-----------------|-------------|---------|
| 小型(200) | 2.87 | 0.43 | 6.67x |
| 中型(1000) | 16.32 | 2.15 | 7.59x |
| 大型(5000) | 98.64 | 12.84 | 7.68x |
| 超大型(20000) | 487.36 | 65.47 | 7.44x |

## 注意事项

- 对于包含循环引用的复杂对象，建议提供自定义`eq`函数
- 极端大型数据集（10万+元素）可能会消耗较多内存，建议分批处理
- 并发环境下无需额外处理，库内部通过线程局部存储保证线程安全

## 许可证
MIT