RxDBBranch

Defined in: packages/rxdb/src/system/branch.ts:105

分支表

记录当前分支的信息，包括是否激活、是否本地分支、是否远程分支等

Constructors

Constructor

new RxDBBranch(): RxDBBranch;

Returns

RxDBBranch

Properties

activated

activated: boolean;

Defined in: packages/rxdb/src/system/branch.ts:123

activated

---

changes$

changes$: RelationEntitiesObservable<typeof RxDBChange>;

Defined in: packages/rxdb/src/system/branch.ts:155

changes

---

children$

children$: RelationEntitiesObservable<typeof RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:165

children

---

createdAt?

optional createdAt: Date | null;

Defined in: packages/rxdb/src/system/branch.ts:139

createdAt

Default

new Date()

---

fromChangeId?

optional fromChangeId: number | null;

Defined in: packages/rxdb/src/system/branch.ts:133

fromChangeId

---

id

id: string;

Defined in: packages/rxdb/src/system/branch.ts:110

id

---

local

local: boolean;

Defined in: packages/rxdb/src/system/branch.ts:114

local

---

parent$

parent$: RelationEntityObservable<typeof RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:150

parent

---

parentId?

optional parentId: string | null;

Defined in: packages/rxdb/src/system/branch.ts:128

parent id

---

remote

remote: boolean;

Defined in: packages/rxdb/src/system/branch.ts:118

remote

---

syncs$

syncs$: RelationEntitiesObservable<typeof RxDBSync>;

Defined in: packages/rxdb/src/system/branch.ts:160

syncs - Repository sync records for this branch

---

updatedAt?

optional updatedAt: Date | null;

Defined in: packages/rxdb/src/system/branch.ts:145

updatedAt

Default

new Date()

---

[ENTITY_STATIC_TYPES]

static [ENTITY_STATIC_TYPES]: RxDBBranchStaticTypes;

Defined in: packages/rxdb/src/system/branch.ts:106

---

count()

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

Defined in: packages/rxdb/src/system/branch.ts:171

count 查询

Parameters

Parameter	Type	Description
options	CountOptions<typeof RxDBBranch, RxDBBranchRuleGroup>	查询选项

Returns

Observable<number>

---

countAncestors()

static countAncestors: (options?) => Observable<number>;

Defined in: packages/rxdb/src/system/branch.ts:176

查询祖先实体数量

Parameters

Parameter	Type	Description
options?	FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>	查询选项

Returns

Observable<number>

---

countDescendants()

static countDescendants: (options?) => Observable<number>;

Defined in: packages/rxdb/src/system/branch.ts:183

查询子孙实体数量

Parameters

Parameter	Type	Description
options?	FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>	查询选项

Returns

Observable<number>

---

find()

static find: (options) => Observable<RxDBBranch[]>;

Defined in: packages/rxdb/src/system/branch.ts:190

find 查询

Parameters

Parameter	Type	Description
options	FindOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>	查询选项

Returns

Observable<RxDBBranch[]>

---

findAll()

static findAll: (options) => Observable<RxDBBranch[]>;

Defined in: packages/rxdb/src/system/branch.ts:197

findAll 查询

Parameters

Parameter	Type	Description
options	FindAllOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>	查询选项

Returns

Observable<RxDBBranch[]>

---

findAncestors()

static findAncestors: (options?) => Observable<RxDBBranch[]>;

Defined in: packages/rxdb/src/system/branch.ts:204

查询祖先实体

Parameters

Parameter	Type	Description
options?	FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>	查询选项

Returns

Observable<RxDBBranch[]>

---

findByCursor()

static findByCursor: (options) => Observable<RxDBBranch[]>;

Defined in: packages/rxdb/src/system/branch.ts:211

findByCursor 查询

Parameters

Parameter	Type	Description
options	FindByCursorOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>	查询选项

Returns

Observable<RxDBBranch[]>

---

findDescendants()

static findDescendants: (options?) => Observable<RxDBBranch[]>;

Defined in: packages/rxdb/src/system/branch.ts:218

查询子孙实体

Parameters

Parameter	Type	Description
options?	FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>	查询选项

Returns

Observable<RxDBBranch[]>

---

findOne()

static findOne: (options) => Observable<RxDBBranch | undefined>;

Defined in: packages/rxdb/src/system/branch.ts:225

findOne 查询

Parameters

Parameter	Type	Description
options	FindOneOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>	查询选项

Returns

Observable<RxDBBranch | undefined>

---

findOneOrFail()

static findOneOrFail: (options) => Observable<RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:232

findOneOrFail 查询

Parameters

Parameter	Type	Description
options	FindOneOrFailOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>	查询选项

Returns

Observable<RxDBBranch>

---

get()

static get: (options) => Observable<RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:239

get 查询

Parameters

Parameter	Type	Description
options	string	查询选项

Returns

Observable<RxDBBranch>

Methods

remove()

remove(): Promise<RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:247

删除

Returns

Promise<RxDBBranch>

---

reset()

reset(): void;

Defined in: packages/rxdb/src/system/branch.ts:251

重置数据

Returns

void

---

save()

save(): Promise<RxDBBranch>;

Defined in: packages/rxdb/src/system/branch.ts:255

保存

Returns

Promise<RxDBBranch>