pivotick v3.0.0

---

pivotick / Pivot / PivotSaveOutcome

Type Alias: PivotSaveOutcome

PivotSaveOutcome = void | boolean | { cancelled?: boolean; canonicalIds?: Record<string, string>; message?: string; savedEdgeIds?: string[]; savedNodeIds?: string[]; }

Defined in: interfaces/Pivot.ts:204

What PivotDefinition.save reports back.

void or true means everything in the payload was written; false means none of it. An object reports a partial write — anything not named is treated as still unsaved, so a save that names nothing saved nothing. Throwing is equivalent to false, with the error surfaced in the retry toast.

Ids naming an element this run did not create are ignored: a pivot never writes what it did not produce, so it cannot report it written either.

Type Declaration

void

boolean

{ cancelled?: boolean; canonicalIds?: Record<string, string>; message?: string; savedEdgeIds?: string[]; savedNodeIds?: string[]; }

cancelled?

optional cancelled: boolean

The analyst backed out, typically of PivotSaveContext.promptData. Nothing is recorded, no toast is shown, the attempt does not count, and a save over several runs stops here. Every other field is ignored.

canonicalIds?

optional canonicalIds: Record<string, string>

Ids the source system assigned, keyed by the local id.

message?

optional message: string

Shown verbatim in the result toast — why the rest did not save.

savedEdgeIds?

optional savedEdgeIds: string[]

Taken at face value, including for an edge whose endpoints did not save: what the source system says it wrote is not the library's to second-guess.

savedNodeIds?

optional savedNodeIds: string[]

Covers both PivotSavePayload.nodes and its children.