g3-toolkit API Reference
    Preparing search index...

    Interface SerializedUGM

    Serialized UGM format for save/restore (T4).

    Version 2 (issue #17) adds the optional derivations sidecar. The field was added under a version bump rather than silently because this document is read back by UGM.fromJSON, and a reader must be able to tell "no derivations" from "written by a build that did not know about them". A document with no version is the form every build before 2 wrote; fromJSON reads it as 1 and still loads it.

    interface SerializedUGM {
        derivations?: DerivationRecord[];
        edges: {
            attributes: EdgeAttributes;
            id: string;
            source: string;
            target: string;
        }[];
        nodes: { attributes: NodeAttributes; id: string }[];
        version?: 1 | 2;
    }
    Index

    Properties

    derivations?: DerivationRecord[]

    Derivation stamps (version 2). Omitted when the registry is empty, so a graph with no derived values serializes as before apart from version.

    edges: {
        attributes: EdgeAttributes;
        id: string;
        source: string;
        target: string;
    }[]
    nodes: { attributes: NodeAttributes; id: string }[]
    version?: 1 | 2

    Absent on documents written before the field existed (read as 1). toJSON writes 2.