Member Junction
    Preparing search index...

    Interface WriteBackResult

    Outcome of the engine's ApplyOutputMapping.

    interface WriteBackResult {
        changed: boolean;
        createdChildID?: string;
        createdChildIDs?: string[];
        createdTaggedItemIDs?: string[];
        deletedChildIDs?: string[];
        dryRun?: boolean;
        preservedHumanChildIDs?: string[];
        preservedHumanFields?: string[];
        previewChild?: Record<string, unknown>;
        previewChildren?: Record<string, unknown>[];
        previewErrors?: string[];
        previewFields?: Record<string, unknown>;
        previewTags?: TagWriteBackPreview[];
        previewValues?: WriteBackValuePreview[];
        retiredHumanFields?: string[];
        unchangedChildIDs?: string[];
        updatedChildIDs?: string[];
        updatedRecord: boolean;
        withheldChildEntities?: string[];
        withheldFields?: string[];
        withheldKeptFields?: string[];
    }
    Index

    Properties

    changed createdChildID? createdChildIDs? createdTaggedItemIDs? deletedChildIDs? dryRun? preservedHumanChildIDs? preservedHumanFields? previewChild? previewChildren? previewErrors? previewFields? previewTags? previewValues? retiredHumanFields? unchangedChildIDs? updatedChildIDs? updatedRecord withheldChildEntities? withheldFields? withheldKeptFields?

    Properties

    changed: boolean

    True when anything was written (record field, child insert/update/delete, tag). False for an identical re-run.

    createdChildID?: string

    ID of the created child record, when a single child mapping was applied (absent on a dry-run).

    createdChildIDs?: string[]

    IDs of created child records when childRecords (or fan-out) was applied (absent on a dry-run).

    createdTaggedItemIDs?: string[]

    IDs of created tagged item records (absent on a dry-run).

    deletedChildIDs?: string[]
    dryRun?: boolean

    True when this was a dry-run: values were computed (and field names validated) but NOTHING was saved.

    preservedHumanChildIDs?: string[]

    IDs of human-owned child rows the result also proposed and that were left untouched.

    preservedHumanFields?: string[]
    previewChild?: Record<string, unknown>

    On a dry-run with a single child mapping, the child values the real write WOULD store.

    previewChildren?: Record<string, unknown>[]

    On a dry-run with child mappings, the child values the real write WOULD store (an insert's, or an update's differing ones).

    previewErrors?: string[]

    On a dry run: what the real write would fail on. Absent when the real write would go through.

    previewFields?: Record<string, unknown>

    On a dry-run, the fields the real write WOULD change on the processed record, with their new values.

    previewTags?: TagWriteBackPreview[]

    On a dry-run with tag mappings, the resolved tag previews.

    previewValues?: WriteBackValuePreview[]

    On a dry run: processor-deferred record values (e.g. unmapped outputs) that would be stored. Absent when none would change.

    retiredHumanFields?: string[]

    Fields whose Human value a run that overwrites human values retired (the field is the processor's again).

    unchangedChildIDs?: string[]
    updatedChildIDs?: string[]
    updatedRecord: boolean

    True if the processed record's fields were actually updated (false on a dry-run, and when every mapped field already held its value).

    withheldChildEntities?: string[]
    withheldFields?: string[]

    Mapped fields whose answer was withheld below its confidence floor: cleared where the processor wrote the value.

    withheldKeptFields?: string[]

    Settings

    Member Visibility

    On This Page

    Properties