Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / DonorCandidate

Interface: DonorCandidate

Defined in: packages/core/dist/index.d.ts

One donor candidate surfaced by the DedupIndex fold.

Properties

PropertyTypeDescriptionDefined in
chainstring[]Scope chain for transitive drainage, oldest first.packages/core/dist/index.d.ts
checkpointRef?string-packages/core/dist/index.d.ts
claimedBy?numberSeq of the exclusive node.link that captured this donor, if any.packages/core/dist/index.d.ts
eligiblePaidUsdnumberMatch-eligible (completed, non-running, non-cancelled) payments.packages/core/dist/index.d.ts
hasPaidEntriesboolean-packages/core/dist/index.d.ts
isolationWorktreeboolean-packages/core/dist/index.d.ts
logicalTaskId?string-packages/core/dist/index.d.ts
memoizedFailureboolean-packages/core/dist/index.d.ts
nodeId?stringFrom the abandon payload when the sever named the node.packages/core/dist/index.d.ts
paidUsdnumberTotal paid under the donor's child coverage at fold time.packages/core/dist/index.d.ts
preAbandonStatus"error" | "ok" | "cancelled" | "limit" | "escalated" | "running"Effective root status BEFORE the abandon overlay.packages/core/dist/index.d.ts
retainedCheckpointboolean-packages/core/dist/index.d.ts
rootEntryRefnumber-packages/core/dist/index.d.ts
rootScopestring-packages/core/dist/index.d.ts
spawnKeystring-packages/core/dist/index.d.ts
worktreePinnedboolean-packages/core/dist/index.d.ts