@baukit/data-contracts-dexie

中文文档
0.18.3发布于 2026/11/07MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 7890

Dexie 4.x 执行网络应用的@baukit/数据合同.

中文使用文档

@baukit/data-contracts-dexie

4.x 执行 @baukit/data-contracts 网络 需要关键/值数据、ID排序记录、便携式图案的应用程序 元数据,以及复合写交易.

import { openDexieStore } from '@baukit/data-contracts-dexie';

interface CachedRecord {
  readonly id: string;
  readonly value: string;
}

const storage = await openDexieStore<CachedRecord>('product-cache');
await storage.withTransaction(async (transaction) => {
  await transaction.records.put({ id: 'record-1', value: 'local' });
  await transaction.keyValues.set('outbox:mutation-1', {
    entityId: 'record-1',
    operation: 'put',
  });
});
await storage.close();

该软件包拥有三个通用索引DB对象商店. 它没有定义 产品表、实体关系、软删除行为、修订、同步 协议,或数据库命名政策.

认证产品应使用 @baukit/data-contracts 打电话前 openDexieStore。假缩写DB和 Chromium/WebKit套房管理共享的离线E-F-E身份过渡案例 除了交易合同之外.

交易模式

嵌入式交易明确加入环境交易 通过调用交易范围上下文开始 :

await storage.withTransaction((transaction) =>
  transaction.withTransaction((sameTransaction) => sameTransaction.records.put(record)),
);

从这种范围化的语境组成交易存储库。 一个呼叫 根号 storage 对象是一个独立交易,并在后面序列化 已经启动的交易。 交易背景不得保留 在他们的回话结束之后.

准备网络、本地、加密、文件系统或其他外部承诺结果 在打开书面交易之前。 德克西追踪自己的承诺区,但 不相干的承诺层可以让浏览器的索引 DB 请求排出队列和 自动承诺提前。 将回调限制在完整的本地写作集.

别给Dexie带毛毯 PrematureCommitError。这个错误可能意味着 浏览器只承诺了预定写作的早期子集. 把它当作 没有证据的成功可以静静地分割一个复合操作. 接受情况 测试必须观察每一个预定的书写、匹配的发件箱条目和完整 任何一步都失败时倒车.

配额失败表面为 StorageError 有代码 storage_quota_exceeded之后 close() 解析后, 代码操作失败 storage_closed。 。 。 .

核查

pnpm test 用途 fake-indexeddb 并保持快速。 浏览器套件是 将铬和WebKit门分开。 将浏览器安装到本地仓库 缓存并从寄存器根运行 :

PLAYWRIGHT_BROWSERS_PATH="$PWD/typescript/.playwright-browsers" \
  corepack pnpm --dir typescript --filter @baukit/data-contracts-dexie \
  exec playwright install --with-deps chromium webkit
PLAYWRIGHT_BROWSERS_PATH="$PWD/typescript/.playwright-browsers" \
  corepack pnpm --dir typescript --filter @baukit/data-contracts-dexie \
  run test:browser

运行 corepack pnpm --dir typescript run check 正常工作空间大门. 本地软件包 check 脚本还包括浏览器套件, 因此 期望安装两个浏览器二进制 。 CI 应该添加相同的 仓库本地浏览器安装和 test:browser 命令作为单独的 步骤; 工作空间的普通 test 任务故意保持快速.

版本与发布记录

@baukit/data-contracts-dexie 共发布 67 个版本,首次发布于 2026/08/26;过去 12 个月发布了 67 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.18.3latest2026/11/07今天
0.18.22026/11/061 天前
0.18.12026/11/062 天前
0.18.02026/11/052 天前
0.17.12026/11/034 天前
0.17.02026/11/025 天前

关于 @baukit/data-contracts-dexie 的常见问题

@baukit/data-contracts-dexie 是什么?

Dexie 4.x 执行网络应用的@baukit/数据合同.

如何安装 @baukit/data-contracts-dexie?

在项目目录运行 npm install @baukit/data-contracts-dexie,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:dexie(^4.4.6)、@baukit/data-contracts(^0.18.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@baukit/data-contracts-dexie 支持 TypeScript 吗?

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

@baukit/data-contracts-dexie 支持 ESM 还是 CommonJS?

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

@baukit/data-contracts-dexie 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@baukit/data-contracts-dexie 可以商用吗?

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

@baukit/data-contracts-dexie 的下载量有多少?

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

@baukit/data-contracts-dexie 还在维护吗?

最新版本 0.18.3 发布于 2026/11/07(今天);至今共发布 67 个版本,其中过去 12 个月发布了 67 个;首次发布于 2026/08/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。