![\"npm](\"https://img.shields.io/npm/v/@c6i/es-sential\")
\n![\"Zero](\"https://img.shields.io/badge/dependencies-zero-brightgreen\"){kind=icon}
\n![\"Downloads\"/](\"https://img.shields.io/npm/dm/@c6i/es-sential\")
\n![\"License\"/](\"https://img.shields.io/badge/license-MIT-blue\"){kind=icon}
\n\n现代 JavaScript/TypeScript 工具库
\n零依赖 · 类型安全 · 按需加载\n
\n
\n快速开始 •\nAPI 文档 •\n开发路线图 •\n贡献\n
\n\n---\n\n## 简介\n\n**es-sential**（essential：必要的）—— 名字的创意既表达了\"这是必需的\"，又巧妙嵌入了\"ES\"（代表 ECMAScript），一语双关。\n\nes-sential 是一个高质量的实用函数库，包含现代 JavaScript 项目中常用的函数。\n\n我们专注于实现那些难以用 JavaScript 内置方法创建，但又经常需要且有用的函数。\n\n我们不实现那些可以轻松被现代 JavaScript 替代的函数，例如：\n\n- `isArray`（改用 `Array.isArray`）\n- `isNaN`（改用 `Number.isNaN`）\n- `isNumber`（改用 `typeof value === 'number'`）\n- `min`（改用 `Math.min()`）\n\n对于 TC39 提案中涵盖的函数，一旦进入 Stage 3，我们将不再实现。\n\n## 特点\n\n- **📝 TypeScript 原生支持** - 完整的类型定义，IDE 智能提示\n- **📦 双格式输出** - ESM + CJS，支持现代 Node.js 和浏览器\n- **🌲 Tree-shaking 友好** - 按需导入，只打包用到的函数\n- **🎯 零依赖** - 无运行时依赖，体积更小\n- **✅ 测试覆盖** - 每个函数都有完整的单元测试\n\n## 快速开始\n\n### 安装\n\n```bash\nnpm install @c6i/es-sential\n# or\npnpm add @c6i/es-sential\n# or\nyarn add @c6i/es-sential\n```\n\n### 使用方式\n\n```typescript\nimport { noop, isSameValueZero } from '@c6i/es-sential'\n\n// 空操作函数 - 作为默认回调\nfunction fetchData(onSuccess = noop, onError = noop) {\n fetch('/api/data')\n .then(data => onSuccess(data))\n .catch(err => onError(err))\n}\n\n// SameValueZero 比较 - 与 Map/Set 内部逻辑一致\nisSameValueZero(NaN, NaN) // true\nisSameValueZero(-0, +0) // true\nisSameValueZero(1, 1) // true\n```\n\n## API 文档\n\n### `noop()`\n\n空操作函数，执行时什么也不做。\n\n**适用场景：**\n\n- 作为默认回调函数，避免调用时需要反复检查 `if (callback)`\n- 作为可选参数的默认值，简化调用方代码\n- 在测试中作为桩（stub）函数\n- 在高阶函数中作为占位符\n\n```typescript\nimport { noop } from '@c6i/es-sential'\n\n// 作为默认回调参数\nfunction startAnimation(onFrame = noop) {\n let progress = 0\n requestAnimationFrame(function tick() {\n progress += 0.1\n onFrame(progress) // 始终安全，无需检查 undefined\n if (progress < 1) requestAnimationFrame(tick)\n })\n}\n\n// 在数组迭代中临时忽略某些元素\nconst arr = [1, 2, 3]\narr.forEach(noop) // 什么都不做，只是遍历\n```\n\n### `isSameValueZero(value, other)`\n\n比较两个值是否相等，使用 **SameValueZero** 算法。\n\n该算法是 JavaScript 中 `Map` 的键比较、`Set` 的值去重所采用的内部相等性判断规则。\n\n| 比较 | `===` | `Object.is` | `isSameValueZero` |\n| ------------- | ------- | ----------- | ----------------- |\n| `NaN === NaN` | `false` | `true` | `true` |\n| `-0 === +0` | `true` | `false` | `true` |\n| 其他 | 一致 | 一致 | 一致 |\n\n**参数：**\n\n- `value` - 待比较的第一个值\n- `other` - 待比较的第二个值\n\n**返回：** 若两个值满足 SameValueZero 相等则返回 `true`，否则返回 `false`\n\n```typescript\nimport { isSameValueZero } from '@c6i/es-sential'\n\n// 基本类型比较\nisSameValueZero(1, 1) // true\nisSameValueZero('a', 'a') // true\n\n// NaN 比较（SameValueZero 认为 NaN 等于 NaN）\nisSameValueZero(NaN, NaN) // true\n\n// 零值比较（SameValueZero 认为 -0 和 +0 相等）\nisSameValueZero(-0, +0) // true\n\n// 对象比较（引用不同则不等）\nisSameValueZero({}, {}) // false\n\n// 模拟 Map 键比较\nconst map = new Map()\nmap.set(-0, 'minus')\nmap.set(+0, 'plus')\nmap.size // 1，键被覆盖\nisSameValueZero(-0, +0) // true，与 Map 内部逻辑一致\n```\n\n## 开发路线图\n\n**已发布：**\n\n- [x] `noop` - 空操作函数\n- [x] `isSameValueZero` - SameValueZero 相等性比较\n\n**规划中：**\n\n- [ ] Array 工具模块（`chunk`, `uniq`...）\n- [ ] Object 工具模块（`pick`, `omit`...）\n- [ ] String 工具模块（`camelCase`, `kebabCase`...）\n- [ ] Function 工具模块（`debounce`, `throttle`...）\n- [ ] Math 工具模块（`clamp`, `random`...）\n\n## 贡献\n\n欢迎贡献代码、提交 Issue 或建议新功能！\n\n### 开发指南\n\n```bash\n# 安装依赖\npnpm install\n\n# 运行测试\npnpm test\n\n# 构建\npnpm run build\n\n# 代码检查\npnpm run lint\n\n# 类型检查\npnpm run typecheck\n```\n\n### 项目结构\n\n```\nes-sential/\n├── src/\n│ ├── function/ # 函数工具（noop）\n│ ├── utils/ # 通用工具（isSameValueZero）\n│ ├── array/ # 数组工具（待开发）\n│ ├── object/ # 对象工具（待开发）\n│ ├── string/ # 字符串工具（待开发）\n│ └── index.ts # 主入口\n├── notes/ # 开发笔记\n└── dist/ # 构建输出\n```\n\n查看 [notes/README.md](./notes/README.md) 了解开发过程中的学习心得。\n\n## 许可证\n\n[MIT](./LICENSE) © 2025\n\n---\n\n\n如果这个项目对你有帮助，请给个 ⭐️\n
\n","readmeFilename":"README.md"}