特性

🚀 速度是其他对象差异比较库的两倍以上
📦 极其轻量，压缩后<1kb
🌎 支持Deno、Node、网页，甚至服务工作线程。还附带内置的TypeScript类型
🔰 使用非常简单，只有一个diff()函数
📅 完全支持像new Date()和new RegExp()这样的对象

开始使用

首先，安装Microdiff

npm i microdiff

如果你使用Deno，你可以从Deno.land导入，链接为https://deno.land/x/microdiff@VERSION/index.ts（记得将@VERSION更改为你想使用的版本）。

安装后，导入并在两个对象上运行它。

import diff from "microdiff";

const obj1 = {
	originalProperty: true,
};
const obj2 = {
	originalProperty: true,
	newProperty: "new",
};

console.log(diff(obj1, obj2));
// [{type: "CREATE", path: ["newProperty"], value: "new"}]

如果你使用CommonJS，可以这样导入：

const diff = require("microdiff").default;

有三种不同类型的变化：CREATE、REMOVE和CHANGE。 path属性给出了新对象中属性的路径（或在REMOVE情况下的旧对象）。路径中的每个元素都是指向下一级属性的键，直到到达被更改的属性，它是一个字符串或数字，取决于对象是数组还是对象（带数字键的对象仍然是字符串）。 value属性存在于CREATE和CHANGE类型中，它包含添加/更改/删除的属性的值。 oldValue属性存在于CHANGE和REMOVE类型中，它包含属性的旧值。

循环引用支持

默认情况下，Microdiff支持循环引用，但如果你确定对象没有循环，比如解析的JSON，你可以使用cyclesFix选项禁用循环检测。

diff(obj1, obj2, { cyclesFix: false });

基准测试

小对象基准测试
deep-diff: 17929ns - 慢409%
deep-object-diff: 10763ns - 慢206%
jsdiff: 79700ns - 慢2164%
microdiff: 3520ns - 最快

大对象基准测试
deep-diff: 272887ns - 慢259%
deep-object-diff: 160019ns - 慢111%
jsdiff: 1688294ns - 慢2123%
microdiff: 75934ns - 最快

这些基准测试目前只针对一个小对象和一个非常大的对象，所以可能不太准确。我将继续努力创建更多不同类型的基准测试。

贡献

感谢你帮助这个项目！贡献过程相当简单。首先fork仓库（如果你需要更多关于如何操作的信息，请查看这个GitHub指南），然后克隆到你的电脑上，开始编程！要编译程序，运行npm run build（如果你使用pnpm或yarn，请将npm替换为相应的命令）。这将在/dist目录下创建CommonJS和ESM模块。

要对microdiff进行基准测试，你可以运行npm run bench。这将自动构建Microdiff并运行一个基准测试程序，将microdiff与其他常见的差异比较库进行比较。

最后，Microdiff有一个广泛的测试套件，你应该充分利用它。要确保一切正常工作，你可以运行npm run test。npm run test会构建项目，然后在新版本上运行整个测试套件。如果你正在修复一个bug，请确保为它添加一个测试。另外，在贡献之前，请确保阅读行为准则。