Interface WriteBackResult

interface WriteBackResult {
    createdChildID?: string;
    dryRun?: boolean;
    previewChild?: Record<string, unknown>;
    previewFields?: Record<string, unknown>;
    updatedRecord: boolean;
}

Properties

createdChildID?: string

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

dryRun?: boolean

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

previewChild?: Record<string, unknown>

On a dry-run with a child mapping, the resolved child values that WOULD be created.

previewFields?: Record<string, unknown>

On a dry-run, the resolved field values that WOULD be written to the processed record — the write-back preview.

updatedRecord: boolean

True if the processed record's fields were actually updated (always false on a dry-run).