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

    Interface DatabaseDeleteOperation

    interface DatabaseDeleteOperation {
        _result?: (string | object)[];
        action: "delete";
        broadcast: boolean;
        deleteAll?: boolean;
        documentName: string;
        dryRun?: boolean;
        ids: string[];
        modifiedTime?: number;
        noHook?: boolean;
        pack: string | null;
        parent?: Document<object, DocumentConstructionContext> | null;
        parentUuid?: string | null;
        render?: boolean;
        replacements?: Record<string, string>;
    }
    Index

    Properties

    _result? action broadcast deleteAll? documentName dryRun? ids modifiedTime? noHook? pack parent? parentUuid? render? replacements?

    Properties

    Optional_result

    _result?: (string | object)[]

    An alias for 'ids' used internally by the server-side backend

    action: "delete"

    The action of this database operation

    broadcast: boolean

    Whether the database operation is broadcast to other connected clients

    deleteAll?: boolean

    Delete all documents in the Collection, regardless of _id

    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 deleted.

    ids: string[]

    An array of Document ids which should be deleted

    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

    render?: boolean

    Re-render Applications whose display depends on the deleted Documents

    replacements?: Record<string, string>

    The mapping of IDs of deleted Documents to the UUIDs of the Documents that replace the deleted Documents

    Settings

    Member Visibility

    On This Page

    Properties