Skip to content

Commit 9b6ba24

Browse files
committed
docs: 完善文档,补充缺失的 API 说明
- 更新 README.md: 补充 10 个缺失的 API(从 11 个增加到 21 个) - 新增集合管理分类(3 个方法) - 新增工具方法分类(3 个方法) - 补充查询方法、缓存维护、连接与事件的完整列表 - 新增 docs/collection-management.md - createCollection(): 创建集合(标准/固定/验证规则) - dropCollection(): 删除集合 - createView(): 创建视图集合 - 包含 20+ 个使用示例和最佳实践 - 新增 docs/utilities.md - getCache(): 获取缓存实例(支持 keys() 方法获取集合缓存) - getDefaults(): 获取默认配置 - getNamespace(): 获取命名空间信息 - 包含缓存监控、配置验证、命名空间追踪等高级用法 - 提供完整的 CacheManager 工具类 - 补充 docs/cache.md - 新增「缓存失效 API」章节 - 详细说明 invalidate() 方法的使用场景和最佳实践 - 补充与自动失效的区别 文档覆盖率: 61.9% → 100% ✅ README API 列出率: 52.4% → 100% ✅
1 parent e889b4a commit 9b6ba24

4 files changed

Lines changed: 2106 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,26 +79,46 @@ const MonSQLize = require('monsqlize');
7979
| **find()** | 批量查询(支持数组和流式) | [docs/find.md](./docs/find.md) |
8080
| **findOne()** | 查询单个文档 | [docs/findOne.md](./docs/findOne.md) |
8181
| **findPage()** | 分页查询(游标/跳页/总数) | [docs/findPage.md](./docs/findPage.md) |
82+
| **stream()** | 流式查询(find 的语法糖) | [docs/find.md](./docs/find.md#流式传输) |
8283
| **aggregate()** | 聚合管道查询 | [docs/aggregate.md](./docs/aggregate.md) |
8384
| **distinct()** | 字段去重查询 | [docs/distinct.md](./docs/distinct.md) |
8485
| **count()** | 统计文档数量 | [docs/count.md](./docs/count.md) |
8586
| **explain()** | 查询计划分析 | [docs/explain.md](./docs/explain.md) |
8687

88+
### 集合管理
89+
90+
| 方法 | 说明 | 文档链接 |
91+
|------|------|---------|
92+
| **createCollection()** | 创建集合 | [docs/collection-management.md](./docs/collection-management.md) |
93+
| **dropCollection()** | 删除集合 | [docs/collection-management.md](./docs/collection-management.md) |
94+
| **createView()** | 创建视图集合 | [docs/collection-management.md](./docs/collection-management.md) |
95+
8796
### 缓存与维护
8897

8998
| 方法 | 说明 | 文档链接 |
9099
|------|------|---------|
91100
| **cache** | 缓存策略配置 | [docs/cache.md](./docs/cache.md) |
101+
| **invalidate()** | 手动失效缓存 | [docs/cache.md](./docs/cache.md#缓存失效-api) |
92102
| **prewarmBookmarks()** | 预热分页书签 | [docs/bookmarks.md](./docs/bookmarks.md) |
93103
| **listBookmarks()** | 列出书签信息 | [docs/bookmarks.md](./docs/bookmarks.md) |
94104
| **clearBookmarks()** | 清理书签缓存 | [docs/bookmarks.md](./docs/bookmarks.md) |
95105

96106
### 连接与事件
97107

98-
| 主题 | 说明 | 文档链接 |
108+
| 方法 | 说明 | 文档链接 |
109+
|------|------|---------|
110+
| **connect()** | 连接数据库 | [docs/connection.md](./docs/connection.md) |
111+
| **close()** | 关闭连接 | [docs/connection.md](./docs/connection.md#关闭连接) |
112+
| **health()** | 健康检查 | [docs/connection.md](./docs/connection.md#健康检查) |
113+
| **on()** / **off()** | 事件监听/取消 | [docs/events.md](./docs/events.md) |
114+
115+
### 工具方法
116+
117+
| 方法 | 说明 | 文档链接 |
99118
|------|------|---------|
100-
| **连接管理** | 连接、关闭、跨库访问 | [docs/connection.md](./docs/connection.md) |
101-
| **事件系统** | 监听连接、错误、慢查询 | [docs/events.md](./docs/events.md) |
119+
| **getCache()** | 获取缓存实例 | [docs/utilities.md](./docs/utilities.md) |
120+
| **getDefaults()** | 获取默认配置 | [docs/utilities.md](./docs/utilities.md) |
121+
| **getNamespace()** | 获取命名空间信息 | [docs/utilities.md](./docs/utilities.md) |
102122

103123
---
104124

0 commit comments

Comments
 (0)