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

    Interface DataModelCleaningOptions

    interface DataModelCleaningOptions {
        addTypes?: boolean;
        copy?: boolean;
        expand?: boolean;
        migrate?: boolean;
        model?: boolean;
        partial?: boolean;
        persisted?: boolean;
        prune?: boolean;
        sanitize?: boolean | DataModelSanitizationOptions;
    }
    Index

    Properties

    addTypes? copy? expand? migrate? model? partial? persisted? prune? sanitize?

    Properties

    addTypes?: boolean

    Impute types for polymorphic so that those typed fields can be later used or validated

    copy?: boolean

    Copy the provided input data to avoid mutating the provided source

    expand?: boolean

    Automatically expand any flattened objects encountered during cleaning

    migrate?: boolean

    Apply model-specific data migrations

    model?: boolean

    Apply joint model-level cleaning rules

    partial?: boolean

    Perform partial cleaning only on the subset of keys included in the input data. If partial is false, values for keys missing in the input data will be imputed if possible

    persisted?: boolean

    Remove keys corresponding with non-persisted DataFields.

    prune?: boolean

    Remove keys which do not belong to the defined data schema

    sanitize?: boolean | DataModelSanitizationOptions

    Configuration of user input sanitization steps that are applied as part of cleaning. For internal server-side use only.

    Settings

    Member Visibility

    On This Page

    Properties