Capabilities → Documentation → Examples → Test Tracking Form

Purpose: Put the user portal, executable examples, and automated tests of core capabilities into the same table to reduce the cost of "the function exists but I don't know where to look/how to verify it."

Core tracking table

CapabilitiesDocumentation EntryOfficial ExamplesAutomated Verification
Connection / Basic 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
Paging / Chain queryfindPage.md / chaining-api.mdexamples/docs/find-page.ts / chaining-api.tstest/integration/model/model-features.test.ts + npm run test:examples
Aggregation / Expressionaggregate.md / expression-functions.mdexamples/docs/aggregate.ts / aggregate-advanced.ts / expression-functions.tstest/unit/expression/*.test.ts
Write extension / 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 management capabilitiescollection-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 / Multiple connection poolmulti-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 automatic conversionobjectid-auto-convert.md / objectid-cross-version.mdexamples/docs/objectid.tsnpm run test:examples

Usage suggestions

  1. Look at the document entry first: clarify capability boundaries and public APIs.
  2. Run the corresponding example again: Verify the minimum executable path and recommended writing method.
  3. Final look at testing: Confirm boundary conditions, regression points and compatible guards.

Maintenance rules

  • When adding new capabilities, at least update the documentation entrance/an official example/an automated verification point simultaneously.
  • When adding a new example, give priority to including it in npm run test:examples.
  • After hotspot reconstruction, the focus regression chain referenced by test:refactor-guard will be supplemented first.