跳到主要内容

WorkingTreeDiffOptions

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

一次 diff() 的可选项（contracts/core-api.md §3）。

Remarks​

键集是封闭的：四个键里没有任何一个指向第二个比较端。新增键之前先回答 「它会不会让调用方问出一个 commit() 无法据以提交的问题」——from / to / ref 都会，所以它们不在这里。

Properties​

cursor?​

readonly optional cursor?: string;

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

上一页的 WorkingTreeDiff.nextCursor；从它之后接着读。只在 granularity: 'entity' 下可用

entities?​

readonly optional entities?: readonly string[];

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

只看这些实体名；给空数组即「一个都不看」，不当成「不过滤」

granularity?​

readonly optional granularity?: WorkingTreeDiffGranularity;

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

摊开的粒度，默认 'entity'

limit?​

readonly optional limit?: number;

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

本页最多给几行；不给即一次给全。只在 granularity: 'entity' 下可用