Type Alias PopulateOptions<T>

PopulateOptions: {
    match?: FilterQuery<T>;
    model?: SchemaModelNames;
    options?: { lean?: boolean | { defaults?: boolean; getters?: boolean } };
    path: string;
    populate?: string | PopulateOptions<T> | (string | PopulateOptions<T>)[];
    select?: string;
    strictPopulate?: boolean;
    transform?: (doc: any, id: string) => any;
}

extracted from mongoose docs

Type Parameters

  • T

Type declaration

  • Optionalmatch?: FilterQuery<T>

    query conditions to match

  • Optionalmodel?: SchemaModelNames

    optional model to use for population

  • Optionaloptions?: { lean?: boolean | { defaults?: boolean; getters?: boolean } }

    optional query options

  • path: string

    space delimited path(s) to populate

  • Optionalpopulate?: string | PopulateOptions<T> | (string | PopulateOptions<T>)[]

    deep populate

  • Optionalselect?: string

    fields to select

  • OptionalstrictPopulate?: boolean

    optional boolean, set to false to allow populating paths that aren't in the schema

  • Optionaltransform?: (doc: any, id: string) => any

    transform function to call on every populated doc

Settings

Member Visibility