Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / ToolEvents

Type Alias: ToolEvents

ts
type ToolEvents = 
  | {
  risk?: Json;
  toolName: string;
  type: "tool:start";
}
  | {
  advisory?: Json;
  decidedBy?: string;
  durationMs: number;
  outcome: "ok" | "error" | "denied";
  rule?: Json;
  toolName: string;
  type: "tool:end";
  verdict?: "allow" | "deny" | "ask";
};

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

Tool lifecycle (emitters arrive with the tool system, M3).

Union Members

Type Literal

ts
{
  risk?: Json;
  toolName: string;
  type: "tool:start";
}

Type Literal

ts
{
  advisory?: Json;
  decidedBy?: string;
  durationMs: number;
  outcome: "ok" | "error" | "denied";
  rule?: Json;
  toolName: string;
  type: "tool:end";
  verdict?: "allow" | "deny" | "ask";
}
NameTypeDescriptionDefined in
advisory?Json-packages/core/dist/index.d.ts
decidedBy?string-packages/core/dist/index.d.ts
durationMsnumber-packages/core/dist/index.d.ts
outcome"ok" | "error" | "denied"-packages/core/dist/index.d.ts
rule?Json-packages/core/dist/index.d.ts
toolNamestring-packages/core/dist/index.d.ts
type"tool:end"-packages/core/dist/index.d.ts
verdict?"allow" | "deny" | "ask"Audit fields (M5-T05): the chain verdict, the deciding layer, the matched rule, and advisory domain-rule matches. Telemetry, never identity; ask verdicts additionally journal as suspended approvals.packages/core/dist/index.d.ts