ITreeRepository<T>
Defined in: rxdb-plugin-tree/src/repository/tree-repository.interface.ts:42
树结构仓库接口
Extends
IRepository<T>
Type Parameters
| Type Parameter |
|---|
T extends EntityType |
Methods
count()
count(options): Promise<number>;
Defined in: rxdb/dist/repository/repository.interface.d.ts:33
查询实体数量
Parameters
| Parameter | Type | Description |
|---|---|---|
options | EntityStaticType<T, "countOptions"> | 查询选项(详见 CountOptions) |
Returns
Promise<number>
满足条件的行数
Inherited from
countAncestors()
countAncestors(options): Promise<number>;
Defined in: rxdb-plugin-tree/src/repository/tree-repository.interface.ts:75
查询祖先节点数量
Parameters
| Parameter | Type |
|---|---|
options | FindTreeOptions<T> |
Returns
Promise<number>
Remarks
指定 entityId 时:不包含当前节点,只统计祖先数量
countDescendants()
countDescendants(options): Promise<number>;
Defined in: rxdb-plugin-tree/src/repository/tree-repository.interface.ts:59
查询子孙实体数量
Parameters
| Parameter | Type |
|---|---|
options | FindTreeOptions<T> |
Returns
Promise<number>
Remarks
- 指定 entityId 时:不包含当前节点,只统计后代数量
- 不指定 entityId 时:统计所有根节点及其后代的总数
create()
create(entity): Promise<InstanceType<T>>;
Defined in: rxdb/dist/repository/repository.interface.d.ts:40
创建实体
Parameters
| Parameter | Type | Description |
|---|---|---|
entity | InstanceType<T> | 实体实例(通常由 EntityManager.instantiate 创建) |
Returns
Promise<InstanceType<T>>
持久化完成后的实体;与入参不是同一引用(实现可换新实例)
Inherited from
find()
find(options): Promise<InstanceType<T>[]>;
Defined in: rxdb/dist/repository/repository.interface.d.ts:26
查询多个实体
Parameters
| Parameter | Type | Description |
|---|---|---|
options | EntityStaticType<T, "findOptions"> | 查询选项(详见 FindOptions) |
Returns
Promise<InstanceType<T>[]>
满足条件的实体数组;无匹配返回空数组(不抛错)
Remarks
返回的是实体实例(带状态机),不是裸数据 —— 调用方后续 save() / remove()
等操作会沿用同一个状态对象,避免"查询回来就丢上下文"。
Inherited from
findAncestors()
findAncestors(options): Promise<InstanceType<T>[]>;
Defined in: rxdb-plugin-tree/src/repository/tree-repository.interface.ts:67
查询祖先节点
Parameters
| Parameter | Type |
|---|---|
options | FindTreeOptions<T> |
Returns
Promise<InstanceType<T>[]>
Remarks
指定 entityId 时:包含当前节点 + 祖先节点
findDescendants()
findDescendants(options): Promise<InstanceType<T>[]>;
Defined in: rxdb-plugin-tree/src/repository/tree-repository.interface.ts:50
查询子孙实体
Parameters
| Parameter | Type |
|---|---|
options | FindTreeOptions<T> |
Returns
Promise<InstanceType<T>[]>
Remarks
- 指定 entityId 时:包含当前节点 + 子孙节点
- 不指定 entityId 时:返回所有根节点及其子孙
remove()
remove(entity): Promise<InstanceType<T>>;
Defined in: rxdb/dist/repository/repository.interface.d.ts:55
删除实体
Parameters
| Parameter | Type | Description |
|---|---|---|
entity | InstanceType<T> | 待删除的实体(按 id 定位) |
Returns
Promise<InstanceType<T>>
删除完成后的实体(字段清空、local 置为 false)
Inherited from
update()
update(entity, patch): Promise<InstanceType<T>>;
Defined in: rxdb/dist/repository/repository.interface.d.ts:48
更新实体
Parameters
| Parameter | Type | Description |
|---|---|---|
entity | InstanceType<T> | 待更新的实体(提供 id 与最新字段) |
patch | Partial<InstanceType<T>> | 字段级 patch;未列出的字段不会被改动 |
Returns
Promise<InstanceType<T>>
持久化完成后的实体