@ark7/model - v2.0.56
    Preparing search index...

    Interface DocumentToObjectOptions

    interface DocumentToObjectOptions {
        depopulate?: boolean;
        field?: CombinedModelField;
        flattenMaps?: boolean;
        getters?: boolean;
        level?: number;
        manager?: Manager;
        minimize?: boolean;
        transform?: boolean | ((doc: any, ret: any, options: any) => any);
        versionKey?: boolean;
        virtuals?: boolean | string[];
    }
    Index

    Properties

    depopulate? field? flattenMaps? getters? level? manager? minimize? transform? versionKey? virtuals?

    Properties

    depopulate?: boolean

    depopulate any populated paths, replacing them with their original refs (defaults to false)

    field?: CombinedModelField

    model field

    flattenMaps?: boolean

    whether to convert Maps to POJOs. (defaults to false)

    getters?: boolean

    apply all getters (path and virtual getters)

    level?: number

    data level for projection. (defaults to null)

    manager?: Manager
    minimize?: boolean

    remove empty objects (defaults to true)

    transform?: boolean | ((doc: any, ret: any, options: any) => any)

    A transform function to apply to the resulting document before returning

    The mongoose document which is being converted

    The plain object representation which has been converted

    The options in use (either schema options or the options passed inline)

    versionKey?: boolean

    whether to include the version key (defaults to true)

    virtuals?: boolean | string[]

    apply virtual getters (can override getters option)

    Settings

    Member Visibility

    On This Page

    Properties