RunOctoGuideRulesResult

Returned data from running runOctoGuideRules.

Example

const { entity, reports } = await runOctoGuideRules({
  entity: "https://github.com/OctoGuide/bot/issues/19",
});

console.log("Entity URL:", entity.data.html_url);
console.log("Received reports:", reports);

Properties

entity

entity: Entity

The entity that was scanned.

---

reports

reports: RuleReport[]

Any reports generated by the rules.