TreeAdjacencyListEntityBase

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:76

树形实体装饰器配置 定义了树形结构所需的父子关系

Extends

• EntityBase

Implements

• ITreeEntity

Constructors

Constructor

new TreeAdjacencyListEntityBase(_initData?): TreeAdjacencyListEntityBase;

Defined in: packages/rxdb/src/entity/EntityBase.ts:200

实体基类构造函数 子类会通过 Entity 装饰器增强此构造函数

Parameters

Parameter	Type	Description
_initData?	any	可选的初始化数据

Returns

TreeAdjacencyListEntityBase

Inherited from

EntityBase.constructor

Properties

createdAt

readonly createdAt: Date;

Defined in: packages/rxdb/src/entity/EntityBase.ts:96

创建时间 实体创建时自动设置为当前时间

Implementation of

ITreeEntity.createdAt

Inherited from

EntityBase.createdAt

---

createdBy?

readonly optional createdBy: `${string}-${string}-${string}-${string}-${string}` | null;

Defined in: packages/rxdb/src/entity/EntityBase.ts:108

创建者ID 记录创建此实体的用户ID

Implementation of

ITreeEntity.createdBy

Inherited from

EntityBase.createdBy

---

id

readonly id: `${string}-${string}-${string}-${string}-${string}`;

Defined in: packages/rxdb/src/entity/EntityBase.ts:90

实体唯一标识符 自动生成的UUID，作为主键

Implementation of

ITreeEntity.id

Inherited from

EntityBase.id

---

parentId?

optional parentId: `${string}-${string}-${string}-${string}-${string}` | null;

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:80

父节点ID

Implementation of

ITreeEntity.parentId

---

remove()

remove: () => Promise<any>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:183

删除

Returns

Promise<any>

Inherited from

EntityBase.remove

---

reset()

reset: () => void;

Defined in: packages/rxdb/src/entity/EntityBase.ts:187

重置数据

Returns

void

Inherited from

EntityBase.reset

---

save()

save: () => Promise<any>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:191

保存

Returns

Promise<any>

Inherited from

EntityBase.save

---

updatedAt

readonly updatedAt: Date;

Defined in: packages/rxdb/src/entity/EntityBase.ts:102

更新时间 实体创建或更新时自动设置为当前时间

Implementation of

ITreeEntity.updatedAt

Inherited from

EntityBase.updatedAt

---

updatedBy?

readonly optional updatedBy: `${string}-${string}-${string}-${string}-${string}` | null;

Defined in: packages/rxdb/src/entity/EntityBase.ts:114

更新者ID 记录最后更新此实体的用户ID

Implementation of

ITreeEntity.updatedBy

Inherited from

EntityBase.updatedBy

---

count()

static count: <T>(this, options) => Observable<number>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:175

查询实体数量

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	CountOptions<() => T>	查询选项，包含 where 条件

Returns

Observable<number>

Observable 包装的数量

Inherited from

EntityBase.count

---

countAncestors()

static countAncestors: <T>(this, options) => Observable<number>;

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:117

统计祖先节点数量

Type Parameters

Type Parameter
T extends TreeAdjacencyListEntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindTreeOptions<() => T>	查询选项，包含实体ID和层级深度

Returns

Observable<number>

Observable 包装的祖先节点数量

---

countDescendants()

static countDescendants: <T>(this, options) => Observable<number>;

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:97

统计子孙节点数量

Type Parameters

Type Parameter
T extends TreeAdjacencyListEntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindTreeOptions<() => T>	查询选项，包含实体ID和层级深度

Returns

Observable<number>

Observable 包装的子孙节点数量

---

find()

static find: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:148

查询多个实体

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindOptions<() => T>	查询选项，包含 where 条件、limit、offset 等

Returns

Observable<T[]>

Observable 包装的实体实例数组

Inherited from

EntityBase.find

---

findAll()

static findAll: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:155

查询所有实体

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindAllOptions<() => T>	查询选项，包含 where 条件和排序（不限制数量）

Returns

Observable<T[]>

Observable 包装的实体实例数组

Inherited from

EntityBase.findAll

---

findAncestors()

static findAncestors: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:107

查询所有祖先节点

Type Parameters

Type Parameter
T extends TreeAdjacencyListEntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindTreeOptions<() => T>	查询选项，包含实体ID和层级深度

Returns

Observable<T[]>

Observable 包装的祖先节点数组

---

findByCursor()

static findByCursor: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:165

通过游标进行分页查询

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindByCursorOptions<() => T>	游标分页选项，包含 orderBy、before/after 游标

Returns

Observable<T[]>

Observable 包装的实体实例数组

Inherited from

EntityBase.findByCursor

---

findDescendants()

static findDescendants: <T>(this, options) => Observable<T[]>;

Defined in: packages/rxdb/src/entity/TreeEntityBase.ts:87

查询所有子孙节点

Type Parameters

Type Parameter
T extends TreeAdjacencyListEntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindTreeOptions<() => T>	查询选项，包含实体ID和层级深度

Returns

Observable<T[]>

Observable 包装的子孙节点数组

---

findOne()

static findOne: <T>(this, options) => Observable<T | null>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:128

查找一个实体

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindOneOptions<() => T>	查询选项，包含 where 条件

Returns

Observable<T | null>

Observable 包装的实体实例或 null

Inherited from

EntityBase.findOne

---

findOneOrFail()

static findOneOrFail: <T>(this, options) => Observable<T>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:138

查找一个实体，查不到就抛出错误

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
options	FindOneOrFailOptions<() => T>	查询选项，包含 where 条件

Returns

Observable<T>

Observable 包装的实体实例

Inherited from

EntityBase.findOneOrFail

---

get()

static get: <T>(this, id) => Observable<T>;

Defined in: packages/rxdb/src/entity/EntityBase.ts:121

根据 id 获取实体

Type Parameters

Type Parameter
T extends EntityBase

Parameters

Parameter	Type	Description
this	() => T	-
id	`${string}-${string}-${string}-${string}-${string}`	实体的唯一标识符

Returns

Observable<T>

Observable 包装的实体实例

Inherited from

EntityBase.get