@graphty/graphty-element / session / RunOutcome

Interface: RunOutcome<T>

Defined in: graphty-element/src/session/runs/Run.ts:170

What the thing doing the work hands back.

The fields and caveats travel with the result rather than being restated by the run, because only the implementation knows what it actually filled in and in what arithmetic.

Type Parameters

T

T = RunResult

Properties

caveats?

readonly optional caveats?: Partial<Caveats>

Defined in: graphty-element/src/session/runs/Run.ts:174

What qualifies the numbers, merged over the defaults the run started with.

---

fields?

readonly optional fields?: readonly FieldDescriptor[]

Defined in: graphty-element/src/session/runs/Run.ts:176

The fields this run actually published, which may be fewer than the algorithm declares.

---

partial?

readonly optional partial?: boolean

Defined in: graphty-element/src/session/runs/Run.ts:180

Whether the work stopped before it finished. Taken from the time box when absent.

---

partialReason?

readonly optional partialReason?: string

Defined in: graphty-element/src/session/runs/Run.ts:182

Why it stopped early, in a sentence.

---

result

readonly result: T

Defined in: graphty-element/src/session/runs/Run.ts:172

The result the run resolves to.

---

summary?

readonly optional summary?: ResultSummary

Defined in: graphty-element/src/session/runs/Run.ts:178

The bounded form of the result, for the run's record.