Interface DatabaseCreateOperation

interface DatabaseCreateOperation {
    _createData?: Record<string, object>;
    _result?: (string | object)[];
    action: "create";
    broadcast: boolean;
    data: object[];
    keepEmbeddedIds?: boolean;
    keepId?: boolean;
    modifiedTime?: number;
    noHook?: boolean;
    pack: null | string;
    parent?: null | Document<object, DocumentConstructionContext>;
    parentUuid?: null | string;
    render?: boolean;
    renderSheet?: boolean;
}

Properties

_createData? _result? action broadcast data keepEmbeddedIds? keepId? modifiedTime? noHook? pack parent? parentUuid? render? renderSheet?

Properties

Optional_createData

_createData?: Record<string, object>

Used internally by server-side backend

Optional_result

_result?: (string | object)[]

Used internally by the server-side backend

action

action: "create"

The action of this database operation

broadcast

broadcast: boolean

Whether the database operation is broadcast to other connected clients

data

data: object[]

An array of data objects from which to create Documents

OptionalkeepEmbeddedIds

keepEmbeddedIds?: boolean

Retain the _id values of embedded document data instead of generating new ids for each embedded document

OptionalkeepId

keepId?: boolean

Retain the _id values of provided data instead of generating new ids

OptionalmodifiedTime

modifiedTime?: number

The timestamp when the operation was performed

OptionalnoHook

noHook?: boolean

Block the dispatch of hooks related to this operation

pack

pack: null | string

A compendium collection ID which contains the Documents

Optionalparent

parent?: null | Document<object, DocumentConstructionContext>

A parent Document within which Documents are embedded

OptionalparentUuid

parentUuid?: null | string

A parent Document UUID provided when the parent instance is unavailable

Optionalrender

render?: boolean

Re-render Applications whose display depends on the created Documents

OptionalrenderSheet

renderSheet?: boolean

Render the sheet Application for any created Documents

Settings

Member Visibility

On This Page

Properties