Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / FinishInfo

Type Alias: FinishInfo

ts
type FinishInfo = 
  | {
  reason: "stop";
}
  | {
  reason: "tool-calls";
}
  | {
  reason: "max-tokens";
}
  | {
  reason: "context-window-exceeded";
}
  | {
  reason: "refusal";
  refusal: RefusalInfo;
};

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

Typed finish outcomes. A refusal MUST surface as a typed finish outcome carrying the provider stop details; it MUST NOT be projected to a null output silently.