rulvar API reference

---

rulvar API reference / @rulvar/plan / PlanOp

Type Alias: PlanOp

type PlanOp = 
  | {
  approach?: string;
  deps?: NodeId[];
  fresh?: boolean;
  lineage?: SpawnLineageOpt;
  op: "add_task";
  priority?: number;
  spec: TaskSpec;
}
  | {
  nodeId: NodeId;
  op: "amend_task";
  spec: TaskSpecPatch;
}
  | {
  nodeId: NodeId;
  op: "park_task";
}
  | {
  nodeId: NodeId;
  op: "unpark_task";
}
  | {
  nodeId: NodeId;
  op: "cancel_task";
  reason?: string;
}
  | {
  nodeId: NodeId;
  op: "reprioritize";
  priority: number;
}
  | {
  deps: NodeId[];
  nodeId: NodeId;
  op: "rewire_deps";
}
  | {
  dep: NodeId;
  nodeId: NodeId;
  op: "waive_dep";
};

Defined in: packages/plan/src/plan-entries.ts:45

The orchestrator-facing PlanOp union.

Union Members

Type Literal

{
  approach?: string;
  deps?: NodeId[];
  fresh?: boolean;
  lineage?: SpawnLineageOpt;
  op: "add_task";
  priority?: number;
  spec: TaskSpec;
}

Name	Type	Description	Defined in
approach?	string	-	packages/plan/src/plan-entries.ts:52
deps?	NodeId[]	-	packages/plan/src/plan-entries.ts:49
fresh?	boolean	Forbids reuse-by-reference for this addition (DEF-5).	packages/plan/src/plan-entries.ts:54
lineage?	SpawnLineageOpt	-	packages/plan/src/plan-entries.ts:51
op	"add_task"	-	packages/plan/src/plan-entries.ts:47
priority?	number	-	packages/plan/src/plan-entries.ts:50
spec	TaskSpec	-	packages/plan/src/plan-entries.ts:48

---

Type Literal

{
  nodeId: NodeId;
  op: "amend_task";
  spec: TaskSpecPatch;
}

---

Type Literal

{
  nodeId: NodeId;
  op: "park_task";
}

---

Type Literal

{
  nodeId: NodeId;
  op: "unpark_task";
}

---

Type Literal

{
  nodeId: NodeId;
  op: "cancel_task";
  reason?: string;
}

---

Type Literal

{
  nodeId: NodeId;
  op: "reprioritize";
  priority: number;
}

---

Type Literal

{
  deps: NodeId[];
  nodeId: NodeId;
  op: "rewire_deps";
}

---

Type Literal

{
  dep: NodeId;
  nodeId: NodeId;
  op: "waive_dep";
}