🧪 Examples Gallery

文档站中的每个核心 API,都应尽量对应到当前仓库内可直接运行的示例

当前官方示例总览见 ../examples/README.md,其中 npm run test:examples 会统一编译并执行当前 43 个 TypeScript 示例;examples/helpers/bootstrap.ts 是辅助模块,不单独执行。

运行方式

npm run build
npm run test:examples

也可以单独执行任意示例:

tsc -p tsconfig.examples.json
node .generated/examples-dist/examples/docs/find.js

快速开始

文档示例
getting-started.mdexamples/quick-start/basic-connect.ts
cache-and-function-cache.mdexamples/cache/with-cache.ts

查询操作

文档示例
find.mdexamples/docs/find.ts
findOne.mdexamples/docs/find-one.ts
find-one-by-id.mdexamples/docs/find-one-by-id.ts
find-by-ids.mdexamples/docs/find-by-ids.ts
findPage.mdexamples/docs/find-page.ts
find-and-count.mdexamples/docs/find-and-count.ts
count.mdexamples/docs/count.ts
distinct.mdexamples/docs/distinct.ts
aggregate.mdexamples/docs/aggregate.ts
explain.mdexamples/docs/explain.ts
chaining-api.mdexamples/docs/chaining-api.ts

写入操作

文档示例
insert-one.mdexamples/docs/insert.ts
insert-many.mdexamples/docs/insert-many.ts
insertBatch.mdexamples/docs/insert.ts
update-one.mdexamples/docs/update-one.ts
update-many.mdexamples/docs/update.ts
updateBatch.mdexamples/docs/update.ts
delete-one.mdexamples/docs/delete.ts
delete-many.mdexamples/docs/delete-many.ts
deleteBatch.mdexamples/docs/delete.ts
upsert-one.mdexamples/docs/upsert-one.ts
replace-one.mdexamples/docs/upsert.ts
find-one-and-update.mdexamples/docs/upsert.ts
find-one-and-replace.mdexamples/docs/upsert.ts
find-one-and-delete.mdexamples/docs/delete.ts
increment-one.mdexamples/docs/update.ts

高级能力

文档示例
expression-functions.mdexamples/docs/expression-functions.ts
model.mdexamples/docs/model.ts
collection-management.mdexamples/docs/collection-management.ts
bookmarks.mdexamples/docs/bookmarks.ts
slow-query-log.mdexamples/docs/slow-query-log.ts
transaction.mdexamples/docs/transaction.ts
watch.mdexamples/docs/watch.ts
examples/README.md(组合能力索引)examples/docs/aggregate-advanced.ts
examples/README.md(组合能力索引)examples/docs/batch-operations.ts
examples/README.md(组合能力索引)examples/docs/soft-delete.ts
examples/README.md(组合能力索引)examples/docs/cache-multilevel.ts
examples/README.md(组合能力索引)examples/docs/objectid.ts
examples/README.md(组合能力索引)examples/docs/pool.ts
failure-recovery-examples.mdexamples/docs/pool-fallback.ts
examples/README.md(组合能力索引)examples/docs/sync.ts
failure-recovery-examples.mdexamples/docs/sync-target-failure.ts
examples/README.md(组合能力索引)examples/docs/lock.ts
failure-recovery-examples.mdexamples/docs/lock-timeout.ts
examples/README.md(组合能力索引)examples/docs/saga.ts
failure-recovery-examples.mdexamples/docs/transaction-rollback.ts
examples/README.md(组合能力索引)examples/docs/populate-relations.ts

说明:部分概念型页面会复用同一个 richer example,而不是为每个标题机械复制一份完全相同的脚本;完整列表以 examples/README.md 为准。