跳到主要内容

ITreeRepository<T>

Defined in: packages/rxdb/src/repository/tree-repository.interface.ts:42

树结构仓库接口

Extends

Type Parameters

Type Parameter
T extends EntityType

Methods

count()

count(options): Promise<number>;

Defined in: packages/rxdb/src/repository/repository.interface.ts:17

查询实体数量

Parameters

ParameterTypeDescription
optionsEntityStaticType<T, "countOptions">查询选项

Returns

Promise<number>

Inherited from

IRepository.count


countAncestors()

countAncestors(options): Promise<number>;

Defined in: packages/rxdb/src/repository/tree-repository.interface.ts:75

查询祖先节点数量

Parameters

ParameterType
optionsFindTreeOptions<T>

Returns

Promise<number>

Remarks

指定 entityId 时:不包含当前节点,只统计祖先数量


countDescendants()

countDescendants(options): Promise<number>;

Defined in: packages/rxdb/src/repository/tree-repository.interface.ts:59

查询子孙实体数量

Parameters

ParameterType
optionsFindTreeOptions<T>

Returns

Promise<number>

Remarks

  • 指定 entityId 时:不包含当前节点,只统计后代数量
  • 不指定 entityId 时:统计所有根节点及其后代的总数

create()

create(entity): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/repository.interface.ts:23

创建实体

Parameters

ParameterType
entityInstanceType<T>

Returns

Promise<InstanceType<T>>

Inherited from

IRepository.create


find()

find(options): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/repository.interface.ts:11

查询多个实体

Parameters

ParameterTypeDescription
optionsEntityStaticType<T, "findOptions">查询选项

Returns

Promise<InstanceType<T>[]>

Inherited from

IRepository.find


findAncestors()

findAncestors(options): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/tree-repository.interface.ts:67

查询祖先节点

Parameters

ParameterType
optionsFindTreeOptions<T>

Returns

Promise<InstanceType<T>[]>

Remarks

指定 entityId 时:包含当前节点 + 祖先节点


findDescendants()

findDescendants(options): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb/src/repository/tree-repository.interface.ts:50

查询子孙实体

Parameters

ParameterType
optionsFindTreeOptions<T>

Returns

Promise<InstanceType<T>[]>

Remarks

  • 指定 entityId 时:包含当前节点 + 子孙节点
  • 不指定 entityId 时:返回所有根节点及其子孙

remove()

remove(entity): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/repository.interface.ts:36

删除实体

Parameters

ParameterType
entityInstanceType<T>

Returns

Promise<InstanceType<T>>

Inherited from

IRepository.remove


update()

update(entity, patch): Promise<InstanceType<T>>;

Defined in: packages/rxdb/src/repository/repository.interface.ts:30

更新实体

Parameters

ParameterType
entityInstanceType<T>
patchPartial<InstanceType<T>>

Returns

Promise<InstanceType<T>>

Inherited from

IRepository.update