# @brooswit/sundry 中文文档

规范地址：https://npmcn.com/package/%40brooswit/sundry/

版本：0\.2\.2
npm 元数据更新时间：2026-08-26T19:51:31.531Z
中文译文更新时间：2026-11-08T16:14:01.386Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：17.2 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-08-24T18:24:17.385Z
- 最新版本发布：2026-08-26T19:51:31.238Z
- 近 30 天下载量：2854（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

一个经过良好测试的小型类型文件工具箱

## 安装

```sh
npm install @brooswit/sundry
```

也可以使用：`pnpm add @brooswit/sundry`、`yarn add @brooswit/sundry`、`bun add @brooswit/sundry`

## README

# @brooswit/ sundry (英语)

一个小型、经过良好测试的TypeScript工具箱。 每一个都是独立的;多加一点.

## `watch(fn, onChange, intervalMs, options?)`

选票 `fn` 间隔和呼叫 `onChange(next, prev)` 当值变化时。 回返a `stop()`。 。 。 .

```ts
import { watch } from "@brooswit/sundry";

const stop = watch(
  () => fs.statSync("config.json").mtimeMs,   // sync or async
  (next, prev) => console.log("changed", prev, "→", next),
  1000,
);
// ...later
stop();   // idempotent
```

-   **第一个呼叫是基线** ——它捕捉到初始值并且确实 _没有_ 开火 `onChange`。 。 。 .
-   **变化被稳定、独立的散列探测到**这样 `{a:1,b:2}` → `{b:2,a:1}` 实值 _没有_ 变化.
-   **适应性粗放.** 每个勾选符运行间隔计时器和 `fn` 一次; 下个勾选开始于两个完成时—— `max(interval, fn-duration)`。斋戒 `fn` 保持平稳间隔; 缓慢 `fn` 连续运行,没有间隙和滴出滴出。 滴答从不重复下一个.
-   **`fn` 可能同步或同步.**
-   **投出/ 弹出跳过此勾选** (不变,基线)。 过 `options.onError` 以观察之.
-   **`options`**数字 : `onError?`, (中文(简体) ), `hash?` (覆盖散列), `setTimeout?`编号 :`clearTimeout?` (输入计时器,例如用于测试).

也导出 : `hashValue`, (中文(简体) ), `stableStringify`, (中文(简体) ), `fnv1a`。 。 。 .

## 发展

```
bun run check       # generate + typecheck + tests + coverage ≥90%   (what CI runs)
bun test
```

每换到 `src/` 需要一个 `CHANGELOG.md` 条目和版本凸起( CI 强制); 合并到 `main` 以出处发布到 npm.

## 常见问题

### @brooswit/sundry 是什么？

一个经过良好测试的小型类型文件工具箱

### 如何安装 @brooswit/sundry？

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

### @brooswit/sundry 支持 TypeScript 吗？

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

### @brooswit/sundry 支持 ESM 还是 CommonJS？

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

### @brooswit/sundry 可以商用吗？

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

### @brooswit/sundry 的下载量有多少？

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

### @brooswit/sundry 还在维护吗？

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