pivotick - v2.0.1
    Preparing search index...

    Type Alias PivotSaveOutcome

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

    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
    • {
          canonicalIds?: Record<string, string>;
          message?: string;
          savedEdgeIds?: string[];
          savedNodeIds?: string[];
      }
      • OptionalcanonicalIds?: Record<string, string>

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

      • Optionalmessage?: string

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

      • OptionalsavedEdgeIds?: 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.

      • OptionalsavedNodeIds?: string[]

        Covers both PivotSavePayload.nodes and its children.

    Settings

    Member Visibility