Rulvar API reference

---

Rulvar API reference / @rulvar/effects / EffectDispatchResult

Type Alias: EffectDispatchResult

type EffectDispatchResult = 
  | {
  outcome: "accepted";
  providerRef?: string;
  receipt?: EffectReceiptObservation;
}
  | {
  detail: string;
  outcome: "failed";
}
  | {
  detail?: string;
  outcome: "unknown";
};

Defined in: packages/effects/src/adapter.ts:59

Union Members

Type Literal

{
  outcome: "accepted";
  providerRef?: string;
  receipt?: EffectReceiptObservation;
}

---

Type Literal

{
  detail: string;
  outcome: "failed";
}

'failed' MUST mean provably not executed (a classified refusal).

---

Type Literal

{
  detail?: string;
  outcome: "unknown";
}