能力 → 文档 → 示例 → 测试追踪表

目的:把核心能力的用户入口、可执行示例、自动化测试放到同一张表里,降低“功能存在但不知道去哪看/怎么验证”的成本。

核心追踪表

能力文档入口官方示例自动化验证
连接 / 基础 CRUDgetting-started.mdexamples/quick-start/basic-connect.tstest/integration/mongodb/connect.test.ts
Query(find / findOne / count / distinct)find.md / findOne.md / count.md / distinct.mdexamples/docs/find.ts / find-one.ts / count.ts / distinct.tstest/integration/mongodb/queries.test.ts
分页 / 链式查询findPage.md / chaining-api.mdexamples/docs/find-page.ts / chaining-api.tstest/integration/model/model-features.test.ts + npm run test:examples
聚合 / 表达式aggregate.md / expression-functions.mdexamples/docs/aggregate.ts / aggregate-advanced.ts / expression-functions.tstest/unit/expression/*.test.ts
写入扩展 / Batchwrite-operations.md / updateBatch.md / deleteBatch.mdexamples/docs/update.ts / batch-operations.tstest/unit/writes/batch.test.ts + test/integration/mongodb/writes-batch.test.ts
Collection 管理能力collection-management.md / create-index.md / database-ops.mdexamples/docs/collection-management.tstest/integration/mongodb/management.test.ts
Cache / Function Cachecache.md / function-cache.md / cache-and-function-cache.mdexamples/cache/with-cache.ts / examples/docs/cache-multilevel.tstest/unit/cache/cache.test.ts / test/unit/function-cache/function-cache.test.ts
Model / Populate / Hooksmodel.md / populate.md / hooks.md / relations.mdexamples/docs/model.ts / populate-relations.tstest/integration/model/model-features.test.ts
Transactiontransaction.md / transaction-optimizations.mdexamples/docs/transaction.ts / transaction-rollback.tstest/integration/transaction/transaction.test.ts
Lockbusiness-lock.mdexamples/docs/lock.ts / lock-timeout.tstest/unit/lock/lock.test.ts
Pool / 多连接池multi-pool.md / multi-pool-health-check.md / pool-chain-api.mdexamples/docs/pool.ts / pool-fallback.tstest/unit/pool/pool.test.ts / test/integration/pool/pool.test.ts
Sync / Resume Tokensync-backup.md / watch.mdexamples/docs/sync.ts / sync-target-failure.tstest/unit/sync/sync.test.ts / test/integration/sync/sync.test.ts
Slow Query Logslow-query-log.mdexamples/docs/slow-query-log.tstest/unit/slow-query-log/slow-query-log.test.ts / test/integration/slow-query-log/slow-query-log.test.ts
Sagasaga-transaction.md / saga-advanced.mdexamples/docs/saga.tstest/unit/saga/saga.test.ts
ObjectId 自动转换objectid-auto-convert.md / objectid-cross-version.mdexamples/docs/objectid.tsnpm run test:examples

使用建议

  1. 先看文档入口:明确能力边界与公开 API。
  2. 再跑对应示例:验证最小可执行路径与推荐写法。
  3. 最后看测试:确认边界条件、回归点和兼容守卫。

维护规则

  • 新增能力时,至少同步更新 文档入口 / 一个官方示例 / 一个自动化验证点
  • 新增示例时,优先把它纳入 npm run test:examples
  • 热点重构后,优先补 test:refactor-guard 所引用的聚焦回归链。