Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface DatabaseUpdateOperation

    interface DatabaseUpdateOperation {
        _result?: (string | object)[];
        _updateData?: Record<string, object>;
        action: "update";
        broadcast: boolean;
        diff?: boolean;
        documentName: string;
        dryRun?: boolean;
        extractedImages?: Record<string, string>;
        modifiedTime?: number;
        noHook?: boolean;
        pack: string | null;
        parent?: Document<object, DocumentConstructionContext> | null;
        parentUuid?: string | null;
        recursive?: boolean;
        render?: boolean;
        updates: object[];
    }
    Index

    Properties

    _result? _updateData? action broadcast diff? documentName dryRun? extractedImages? modifiedTime? noHook? pack parent? parentUuid? recursive? render? updates

    Properties

    Optional_result

    _result?: (string | object)[]

    Used internally by the server-side backend

    Optional_updateData

    _updateData?: Record<string, object>

    Used internally by the server-side backend

    action: "update"

    The action of this database operation

    broadcast: boolean

    Whether the database operation is broadcast to other connected clients

    diff?: boolean

    Difference each update object against current Document data and only use differential data for the update operation

    documentName: string

    The Document name

    dryRun?: boolean

    Is the operation a dry run? If so, an empty result array is returned before the Documents are updated.

    extractedImages?: Record<string, string>

    Base64 images extracted during server-side processing

    modifiedTime?: number

    The timestamp when the operation was performed

    noHook?: boolean

    Block the dispatch of hooks related to this operation

    pack: string | null

    A compendium collection ID which contains the Documents

    parent?: Document<object, DocumentConstructionContext> | null

    A parent Document within which Documents are embedded

    parentUuid?: string | null

    A parent Document UUID provided when the parent instance is unavailable

    recursive?: boolean

    Merge objects recursively. If false, inner objects will be replaced explicitly. Use with caution!

    render?: boolean

    Re-render Applications whose display depends on the created Documents

    updates: object[]

    An array of data objects used to update existing Documents. Each update object must contain the _id of the target Document

    Settings

    Member Visibility

    On This Page

    Properties