Rulvar API reference

---

Rulvar API reference / @rulvar/plan / PinLedger

Class: PinLedger

Defined in: packages/plan/src/park.ts:25

The worktree pin ledger: a pure fold counting live pins from abandon entries carrying retainWorktree: true (park pinning and DEF-5 retention share the cap by construction).

Constructors

Constructor

new PinLedger(): PinLedger;

Returns

PinLedger

Accessors

count

Get Signature

get count(): number;

Defined in: packages/plan/src/park.ts:43

Returns

number

Methods

hasCapacity()

hasCapacity(maxPinnedWorktrees?): boolean;

Defined in: packages/plan/src/park.ts:47

Parameters

Parameter	Type	Default value
maxPinnedWorktrees	number	DEFAULT_MAX_PINNED_WORKTREES

Returns

boolean

---

isPinnedNode()

isPinnedNode(nodeId): boolean;

Defined in: packages/plan/src/park.ts:51

Parameters

Parameter	Type
nodeId	string

Returns

boolean

---

fold()

static fold(entries): PinLedger;

Defined in: packages/plan/src/park.ts:29

Parameters

Parameter	Type
entries	readonly JournalEntry[]

Returns

PinLedger