跳到主要内容

readWorkingTreeDiff()

function readWorkingTreeDiff(
executor,
branchId,
options?
): Promise<WorkingTreeDiff>;

Defined in: packages/rxdb-plugin-working-tree/src/working-tree/diff.ts:272

摊开一条分支的 HEAD ↔ 工作树 差异(FR-005)。

Parameters​

ParameterTypeDescription
executorTransactionExecutor调用方那个事务的执行器;本函数不自己开事务
branchIdstring要摊开的分支
optionsWorkingTreeDiffOptions见 WorkingTreeDiffOptions

Returns​

Promise<WorkingTreeDiff>

见 WorkingTreeDiff

Throws​

RxDBError 工作树状态行缺失时,或事务粒度下给了分页键时 (见 assertPageableGranularity)

Remarks​

branchId 是显式入参而不是「自己读一次 active 分支」:门面上的 diff() 零参、只看当前 分支,而 conformance 套件与恢复路径需要摊开一条指定的分支。把读 active 分支放进这里的话, 后两者就只能先切分支再 diff。

只认 WorkingTreeDiffOptions 里那四个键,不把 options 整个并进查询条件: 并进去的话,调用方传的 { from: 'commit-a' } 会变成一条针对不存在的 from 列的规则, 而替身与真实后端对此的反应各不相同——有的抛错,有的静默地一行都匹配不到。