跳到主要内容

RxDBBranch

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

分支表

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

Constructors

Constructor

new RxDBBranch(): RxDBBranch;

Returns

RxDBBranch

Properties

activated

activated: boolean;

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

activated


changes$

changes$: RelationEntitiesObservable<typeof RxDBChange>;

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

changes


children$

children$: RelationEntitiesObservable<typeof RxDBBranch>;

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

children


createdAt?

optional createdAt?: Date | null;

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

createdAt

Default

new Date()

fromChangeId?

optional fromChangeId?: number | null;

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

fromChangeId


id

id: string;

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

id


local

local: boolean;

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

本地分支


parent$

parent$: RelationEntityObservable<typeof RxDBBranch>;

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

parent


parentId?

optional parentId?: string | null;

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

parent id


remote

remote: boolean;

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

线上已有分支


syncs$

syncs$: RelationEntitiesObservable<typeof RxDBSync>;

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

syncs - Repository sync records for this branch


updatedAt?

optional updatedAt?: Date | null;

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

updatedAt

Default

new Date()

[ENTITY_STATIC_TYPES]

static [ENTITY_STATIC_TYPES]: RxDBBranchStaticTypes;

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


count

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

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

count 查询

Parameters

ParameterTypeDescription
optionsCountOptions<typeof RxDBBranch, RxDBBranchRuleGroup>查询选项

Returns

Observable<number>


countAncestors

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

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

查询祖先实体数量

Parameters

ParameterTypeDescription
options?FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>查询选项

Returns

Observable<number>


countDescendants

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

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

查询子孙实体数量

Parameters

ParameterTypeDescription
options?FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>查询选项

Returns

Observable<number>


find

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

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

find 查询

Parameters

ParameterTypeDescription
optionsFindOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>查询选项

Returns

Observable<RxDBBranch[]>


findAll

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

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

findAll 查询

Parameters

ParameterTypeDescription
optionsFindAllOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>查询选项

Returns

Observable<RxDBBranch[]>


findAncestors

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

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

查询祖先实体

Parameters

ParameterTypeDescription
options?FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>查询选项

Returns

Observable<RxDBBranch[]>


findByCursor

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

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

findByCursor 查询

Parameters

ParameterTypeDescription
optionsFindByCursorOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>查询选项

Returns

Observable<RxDBBranch[]>


findDescendants

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

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

查询子孙实体

Parameters

ParameterTypeDescription
options?FindTreeOptions<typeof RxDBBranch, RxDBBranchTreeRuleGroup>查询选项

Returns

Observable<RxDBBranch[]>


findOne

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

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

findOne 查询

Parameters

ParameterTypeDescription
optionsFindOneOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>查询选项

Returns

Observable<RxDBBranch | undefined>


findOneOrFail

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

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

findOneOrFail 查询

Parameters

ParameterTypeDescription
optionsFindOneOrFailOptions<typeof RxDBBranch, RxDBBranchRuleGroup, RxDBBranchOrderByField>查询选项

Returns

Observable<RxDBBranch>


get

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

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

get 查询

Parameters

ParameterTypeDescription
optionsstring查询选项

Returns

Observable<RxDBBranch>

Methods

remove()

remove(): Promise<RxDBBranch>;

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

删除

Returns

Promise<RxDBBranch>


reset()

reset(): void;

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

重置数据

Returns

void


save()

save(): Promise<RxDBBranch>;

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

保存

Returns

Promise<RxDBBranch>