@storehouse/mongoose - v4.0.0
    Preparing search index...

    Interface CustomModel<TRawDocType, TQueryHelpers, TInstanceMethods, TVirtuals, THydratedDocumentType, TSchema>

    interface CustomModel<
        TRawDocType = unknown,
        TQueryHelpers = unknown,
        TInstanceMethods = unknown,
        TVirtuals = unknown,
        THydratedDocumentType = HydratedDocument<
            TRawDocType,
            TVirtuals & TInstanceMethods,
            TQueryHelpers,
        >,
        TSchema = any,
    > {
        new CustomModel<DocType = Partial<TRawDocType>>(
            doc?: DocType,
            fields?: any,
            options?: AnyObject,
        ): THydratedDocumentType;
        base: __module;
        baseModelName: string | undefined;
        collection: Collection;
        db: Connection;
        discriminators:
            | { [name: string]: Model<any, {}, {}, {}, any, any, any> }
            | undefined;
        events: EventEmitter;
        modelName: string;
        schema: TSchema;
        "[captureRejectionSymbol]"?(
            error: Error,
            event: string | symbol,
            ...args: any[],
        ): void;
        $where(
            argument: string | Function,
        ): QueryWithHelpers<
            THydratedDocumentType[],
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        addListener<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        aggregate<R = any>(
            pipeline?: PipelineStage[],
            options?: AggregateOptions,
        ): Aggregate<R[]>;
        aggregate<R = any>(pipeline: PipelineStage[]): Aggregate<R[]>;
        aggregation<ResultElementType>(): Aggregation<ResultElementType>;
        applyDefaults(obj: AnyObject): AnyObject;
        applyDefaults(obj: TRawDocType): TRawDocType;
        applyTimestamps(
            obj: AnyObject,
            options?: { currentTime?: () => Date; isUpdate?: boolean },
        ): AnyObject;
        applyVirtuals(obj: AnyObject, virtalsToApply?: string[]): AnyObject;
        bulkSave(
            documents: Document<ObjectId, any, any, Record<string, any>, {}>[],
            options?: MongooseBulkSaveOptions,
        ): Promise<MongooseBulkWriteResult>;
        bulkWrite<DocContents = TRawDocType>(
            writes: AnyBulkWriteOperation<
                DocContents extends Document ? DocContents<DocContents> : any,
            >[],
            options: BulkWriteOptions & MongooseBulkWriteOptions & { ordered: false },
        ): Promise<BulkWriteResult & { mongoose?: { validationErrors: Error[] } }>;
        bulkWrite<DocContents = TRawDocType>(
            writes: AnyBulkWriteOperation<
                DocContents extends Document ? DocContents<DocContents> : any,
            >[],
            options?: BulkWriteOptions & MongooseBulkWriteOptions,
        ): Promise<BulkWriteResult>;
        castObject(
            obj: AnyObject,
            options?: { ignoreCastErrors?: boolean },
        ): TRawDocType;
        cleanIndexes(
            options?: { hideIndexes?: boolean; toDrop?: string[] },
        ): Promise<string[]>;
        clientEncryption(): ClientEncryption | null;
        countDocuments(
            filter?: QueryFilter<TRawDocType>,
            options?:
                | CountOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any } & Abortable
                | null,
        ): QueryWithHelpers<
            number,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "countDocuments",
            TInstanceMethods & TVirtuals,
        >;
        countDocuments(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            options?:
                | CountOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any } & Abortable
                | null,
        ): QueryWithHelpers<
            number,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "countDocuments",
            TInstanceMethods & TVirtuals,
        >;
        create(): Promise<null>;
        create(doc: Partial<TRawDocType>): Promise<THydratedDocumentType>;
        create(docs: Partial<TRawDocType>[]): Promise<THydratedDocumentType[]>;
        create(
            docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[],
            options: CreateOptions & { aggregateErrors: true },
        ): Promise<(THydratedDocumentType | Error)[]>;
        create(
            docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[],
            options?: CreateOptions,
        ): Promise<THydratedDocumentType[]>;
        create(
            doc: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>,
        ): Promise<THydratedDocumentType>;
        create(
            ...docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[],
        ): Promise<THydratedDocumentType[]>;
        createCollection<T extends Document>(
            options?: CreateCollectionOptions & Pick<
                SchemaOptions<
                    unknown,
                    {},
                    {},
                    {},
                    {},
                    Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                        _id: ObjectId;
                    } & { __v: number } & { id: string },
                    Model<
                        unknown,
                        {},
                        {},
                        {},
                        Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                            _id: ObjectId;
                        } & { __v: number } & { id: string },
                        any,
                        unknown,
                    >,
                >,
                "expires",
            >,
        ): Promise<Collection<T>>;
        createIndexes(options?: CreateIndexesOptions): Promise<void>;
        createSearchIndex(description: SearchIndexDescription): Promise<string>;
        createSearchIndexes(): Promise<string[]>;
        deleteMany(
            filter?: QueryFilter<TRawDocType>,
            options?:
                | DeleteOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any }
                | null,
        ): QueryWithHelpers<
            DeleteResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "deleteMany",
            TInstanceMethods & TVirtuals,
        >;
        deleteMany(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            options?:
                | DeleteOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any }
                | null,
        ): QueryWithHelpers<
            DeleteResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "deleteMany",
            TInstanceMethods & TVirtuals,
        >;
        deleteOne(
            filter?: QueryFilter<TRawDocType>,
            options?:
                | DeleteOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any }
                | null,
        ): QueryWithHelpers<
            DeleteResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "deleteOne",
            TInstanceMethods & TVirtuals,
        >;
        deleteOne(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            options?:
                | DeleteOptions & Pick<
                    QueryOptions<TRawDocType>,
                    MongooseBaseQueryOptionKeys | "timestamps" | "lean",
                > & { [other: string]: any }
                | null,
        ): QueryWithHelpers<
            DeleteResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "deleteOne",
            TInstanceMethods & TVirtuals,
        >;
        diffIndexes(options?: Record<string, unknown>): Promise<IndexesDiff>;
        discriminator<
            TDiscriminatorSchema extends
                Schema<
                    any,
                    any,
                    {},
                    {},
                    {},
                    {},
                    DefaultSchemaOptions,
                    {
                        [key: number]: unknown;
                        [key: symbol]: unknown;
                        [key: string]: unknown;
                    },
                    Document<
                        unknown,
                        {},
                        {
                            [key: number]: unknown;
                            [key: symbol]: unknown;
                            [key: string]: unknown;
                        },
                        { id: string },
                        ResolveSchemaOptions<DefaultSchemaOptions>,
                    > & Omit<
                        {
                            [key: number]: unknown;
                            [key: symbol]: unknown;
                            [key: string]: unknown;
                        } & Required<{ _id: unknown }> & { __v: number },
                        "id",
                    > & { id: string },

                        | { [path: string]: SchemaDefinitionProperty<undefined, any, any> }
                        | {
                            [key: string]:
                                | SchemaDefinitionProperty<
                                    any,
                                    any,
                                    Document<
                                        unknown,
                                        {},
                                        {
                                            [key: number]: unknown;
                                            [key: symbol]: unknown;
                                            [key: string]: unknown;
                                        },
                                        { id: string },
                                        ResolveSchemaOptions<DefaultSchemaOptions>,
                                    > & Omit<
                                        {
                                            [key: number]: unknown;
                                            [key: symbol]: unknown;
                                            [key: string]: unknown;
                                        } & Required<{ _id: unknown }> & { __v: number },
                                        "id",
                                    > & { id: string },
                                >
                                | undefined;
                        },
                    { [key: number]: {}; [key: symbol]: {}; [key: string]: {} } & Required<
                        { _id: unknown },
                    > & { __v: number },
                >,
        >(
            name: string | number,
            schema: TDiscriminatorSchema,
            value?: string | number | ObjectId | DiscriminatorOptions,
        ): Model<
            TRawDocType & IfAny<
                TDiscriminatorSchema,
                any,
                ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
            >,
            TQueryHelpers & ObtainSchemaGeneric<TDiscriminatorSchema, "TQueryHelpers">,
            TInstanceMethods & ObtainSchemaGeneric<
                TDiscriminatorSchema,
                "TInstanceMethods",
            >,
            TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
            IfAny<
                TRawDocType & IfAny<
                    TDiscriminatorSchema,
                    any,
                    ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                >,
                any,
                (
                    TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                        TDiscriminatorSchema,
                        "TInstanceMethods",
                    >
                ) extends Record<string, never>
                    ? Document<
                        unknown,
                        TQueryHelpers & ObtainSchemaGeneric<
                            TDiscriminatorSchema,
                            "TQueryHelpers",
                        >,
                        TRawDocType & IfAny<
                            TDiscriminatorSchema,
                            any,
                            ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                        >,
                        TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                        DefaultSchemaOptions,
                    > & Require_id<
                        TRawDocType & IfAny<
                            TDiscriminatorSchema,
                            any,
                            ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                        >,
                    > & { __v: number } & AddDefaultId<
                        TRawDocType & IfAny<
                            TDiscriminatorSchema,
                            any,
                            ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                        >,
                        {},
                        DefaultSchemaOptions,
                    >
                    : IfAny<
                        TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                            TDiscriminatorSchema,
                            "TInstanceMethods",
                        >,
                        Document<
                            unknown,
                            TQueryHelpers & ObtainSchemaGeneric<
                                TDiscriminatorSchema,
                                "TQueryHelpers",
                            >,
                            TRawDocType & IfAny<
                                TDiscriminatorSchema,
                                any,
                                ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                            >,
                            TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                            DefaultSchemaOptions,
                        > & Require_id<
                            TRawDocType & IfAny<
                                TDiscriminatorSchema,
                                any,
                                ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                            >,
                        > & { __v: number },
                        Document<
                            unknown,
                            TQueryHelpers & ObtainSchemaGeneric<
                                TDiscriminatorSchema,
                                "TQueryHelpers",
                            >,
                            TRawDocType & IfAny<
                                TDiscriminatorSchema,
                                any,
                                ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                            >,
                            TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                            DefaultSchemaOptions,
                        > & Omit<
                            Require_id<TRawDocType & IfAny<(...), (...), (...)>> & {
                                __v: number;
                            },
                            | keyof TVirtuals
                            | keyof ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">
                            | keyof TInstanceMethods
                            | keyof ObtainSchemaGeneric<TDiscriminatorSchema, "TInstanceMethods">,
                        > & TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                            TDiscriminatorSchema,
                            "TInstanceMethods",
                        >,
                    >,
            >,
            any,
            TRawDocType & IfAny<
                TDiscriminatorSchema,
                any,
                ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
            >,
        > & ObtainSchemaGeneric<TSchema, "TStaticMethods"> & ObtainSchemaGeneric<
            TDiscriminatorSchema,
            "TStaticMethods",
        >;
        discriminator<D>(
            name: string | number,
            schema: Schema,
            value?: string | number | ObjectId | DiscriminatorOptions,
        ): Model<D>;
        discriminator<T, U>(
            name: string | number,
            schema: Schema<T, U>,
            value?: string | number | ObjectId | DiscriminatorOptions,
        ): U;
        distinct<DocKey extends string>(
            field: DocKey,
            filter?: QueryFilter<TRawDocType>,
            options?: QueryOptions<TRawDocType>,
        ): QueryWithHelpers<
            (
                DocKey extends keyof WithLevel1NestedPaths<
                    TRawDocType,
                    keyof TRawDocType,
                >
                    ? WithoutUndefined<
                        Unpacked<
                            WithLevel1NestedPaths<TRawDocType, keyof TRawDocType>[DocKey<
                                DocKey,
                            >],
                        >,
                    >
                    : unknown
            )[],
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "distinct",
            TInstanceMethods & TVirtuals,
        >;
        distinct<DocKey extends string>(
            field: DocKey,
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            options?: QueryOptions<TRawDocType>,
        ): QueryWithHelpers<
            (
                DocKey extends keyof WithLevel1NestedPaths<
                    TRawDocType,
                    keyof TRawDocType,
                >
                    ? WithoutUndefined<
                        Unpacked<
                            WithLevel1NestedPaths<TRawDocType, keyof TRawDocType>[DocKey<
                                DocKey,
                            >],
                        >,
                    >
                    : unknown
            )[],
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "distinct",
            TInstanceMethods & TVirtuals,
        >;
        dropSearchIndex(name: string): Promise<void>;
        emit<E extends string | symbol>(
            eventName: string | symbol,
            ...args: any[],
        ): boolean;
        ensureIndexes(options?: CreateIndexesOptions): Promise<void>;
        estimatedDocumentCount(
            options?: QueryOptions<TRawDocType>,
        ): QueryWithHelpers<
            number,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "estimatedDocumentCount",
            TInstanceMethods & TVirtuals,
        >;
        eventNames(): (string | symbol)[];
        exists(
            filter: QueryFilter<TRawDocType>,
        ): QueryWithHelpers<
            { _id: InferIdType<TRawDocType> }
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        exists(
            filter: Query<any, any>,
        ): QueryWithHelpers<
            { _id: InferIdType<TRawDocType> }
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        find<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            projection: ProjectionType<TRawDocType> | null | undefined,
            options: QueryOptions<TRawDocType> & { lean: true } & Abortable,
        ): QueryWithHelpers<
            (
                Require_id<TRawDocType> extends { __v?: U }
                    ? { __v?: U } & Require_id<TRawDocType>
                    : Require_id<TRawDocType> & { __v: number }
            )[],
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        find(
            filter: Query<any, any>,
            projection: ProjectionType<TRawDocType> | null | undefined,
            options: QueryOptions<TRawDocType> & { lean: true } & Abortable,
        ): QueryWithHelpers<
            (
                Require_id<TRawDocType> extends { __v?: U }
                    ? { __v?: U } & Require_id<TRawDocType>
                    : Require_id<TRawDocType> & { __v: number }
            )[],
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        find<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType>,
            projection?: ProjectionType<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> & Abortable,
        ): QueryWithHelpers<
            ResultDoc[],
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        find(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            projection?: ProjectionType<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> & Abortable,
        ): QueryWithHelpers<
            THydratedDocumentType[],
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        findById<ResultDoc = THydratedDocumentType>(
            id: any,
            projection: ProjectionType<TRawDocType> | null | undefined,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findById<ResultDoc = THydratedDocumentType>(
            id?: any,
            projection?: ProjectionType<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndDelete<ResultDoc = THydratedDocumentType>(
            id: any,
            options: QueryOptions<TRawDocType> & {
                includeResultMetadata: true;
                lean: true;
            },
        ): QueryWithHelpers<
            ModifyResult<TRawDocType>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndDelete<ResultDoc = THydratedDocumentType>(
            id: any,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndDelete<ResultDoc = THydratedDocumentType>(
            id: any,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<ResultDoc>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndDelete<ResultDoc = THydratedDocumentType>(
            id?: any,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & {
                includeResultMetadata: true;
                lean: true;
            },
        ): QueryWithHelpers<
            ModifyResult<TRawDocType>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate(
            filter: Query<any, any>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & {
                includeResultMetadata: true;
                lean: true;
            },
        ): QueryWithHelpers<
            ModifyResult<TRawDocType>,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate<ResultDoc = THydratedDocumentType>(
            id: any,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate<ResultDoc = THydratedDocumentType>(
            id: any,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<ResultDoc>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate<ResultDoc = THydratedDocumentType>(
            id: any,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & ({ upsert: true; } & ReturnsNewDoc),
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType : ResultDoc,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findByIdAndUpdate<ResultDoc = THydratedDocumentType>(
            id?: any,
            update?: UpdateQuery<TRawDocType>,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOne<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            projection: ProjectionType<TRawDocType> | null | undefined,
            options: QueryOptions<TRawDocType> & { lean: true } & Abortable,
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findOne(
            filter: Query<any, any>,
            projection: ProjectionType<TRawDocType> | null | undefined,
            options: QueryOptions<TRawDocType> & { lean: true } & Abortable,
        ): QueryWithHelpers<
            TRawDocType
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findOne<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType>,
            projection?: ProjectionType<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> & Abortable | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findOne(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            projection?: ProjectionType<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> & Abortable | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : THydratedDocumentType | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOne",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete(
            filter: Query<any, any>,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<ResultDoc>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete(
            filter: Query<any, any>,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<THydratedDocumentType>,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType> | null,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndDelete(
            filter?:
                | Query<any, any, {}, unknown, "find", Record<string, never>>
                | null,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : THydratedDocumentType | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndDelete",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace(
            filter: Query<any, any>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            TRawDocType
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<ResultDoc>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace(
            filter: Query<any, any>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<THydratedDocumentType>,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & ({ upsert: true; } & ReturnsNewDoc),
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType : ResultDoc,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace(
            filter: Query<any, any>,
            replacement: AnyObject | TRawDocType,
            options: QueryOptions<TRawDocType> & ({ upsert: true; } & ReturnsNewDoc),
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType
                : THydratedDocumentType,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType>,
            replacement?: AnyObject | TRawDocType,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndReplace(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            replacement?: AnyObject | TRawDocType,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : THydratedDocumentType | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndReplace",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & {
                includeResultMetadata: true;
                lean: true;
            },
        ): QueryWithHelpers<
            ModifyResult<TRawDocType>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate(
            filter: Query<any, any>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & {
                includeResultMetadata: true;
                lean: true;
            },
        ): QueryWithHelpers<
            ModifyResult<TRawDocType>,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            | (
                TRawDocType extends any[]
                    ? (
                        Require_id<TRawDocType> extends { __v?: U }
                            ? { __v?: U } & Require_id<TRawDocType>
                            : Require_id<TRawDocType> & { __v: number }
                    )[]
                    : Require_id<TRawDocType> extends { __v?: U }
                        ? { __v?: U } & Require_id<TRawDocType>
                        : Require_id<TRawDocType> & { __v: number }
            )
            | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate(
            filter: Query<any, any>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { lean: true },
        ): QueryWithHelpers<
            | (
                TRawDocType extends any[]
                    ? (
                        Require_id<TRawDocType> extends { __v?: U }
                            ? { __v?: U } & Require_id<TRawDocType>
                            : Require_id<TRawDocType> & { __v: number }
                    )[]
                    : Require_id<TRawDocType> extends { __v?: U }
                        ? { __v?: U } & Require_id<TRawDocType>
                        : Require_id<TRawDocType> & { __v: number }
            )
            | null,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<ResultDoc>,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate(
            filter: Query<any, any>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & { includeResultMetadata: true },
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? ModifyResult<TRawDocType>
                : ModifyResult<THydratedDocumentType>,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter: QueryFilter<TRawDocType>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & ({ upsert: true; } & ReturnsNewDoc),
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType : ResultDoc,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate(
            filter: Query<any, any>,
            update: UpdateQuery<TRawDocType>,
            options: QueryOptions<TRawDocType> & ({ upsert: true; } & ReturnsNewDoc),
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType
                : THydratedDocumentType,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType>,
            update?: UpdateQuery<TRawDocType>,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        findOneAndUpdate<ResultDoc = THydratedDocumentType>(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            update?: UpdateQuery<TRawDocType>,
            options?: QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true
                ? TRawDocType | null
                : ResultDoc | null,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "findOneAndUpdate",
            TInstanceMethods & TVirtuals,
        >;
        getMaxListeners(): number;
        hydrate(
            obj: any,
            projection?: ProjectionType<TRawDocType>,
            options?: HydrateOptions,
        ): THydratedDocumentType;
        init(): Promise<THydratedDocumentType>;
        insertMany(docs: TRawDocType[]): Promise<THydratedDocumentType[]>;
        insertMany(
            doc: TRawDocType[],
            options: InsertManyOptions & { ordered: false; rawResult: true },
        ): Promise<
            InsertManyResult<Require_id<TRawDocType>> & {
                mongoose: {
                    results: (Object | THydratedDocumentType | Error)[];
                    validationErrors: (CastError | ValidatorError)[];
                };
            },
        >;
        insertMany(
            docs: TRawDocType[],
            options: InsertManyOptions & { lean: true; rawResult: true },
        ): Promise<InsertManyResult<Require_id<TRawDocType>>>;
        insertMany<DocContents = TRawDocType>(
            doc: TRawDocType | DocContents,
            options: InsertManyOptions & { ordered: false; rawResult: true },
        ): Promise<
            InsertManyResult<Require_id<DocContents>> & {
                mongoose: {
                    results: (
                        Object
                        | Error
                        | MergeType<THydratedDocumentType, DocContents>
                    )[];
                    validationErrors: (CastError | ValidatorError)[];
                };
            },
        >;
        insertMany(
            docs: TRawDocType[],
            options: InsertManyOptions & { lean: true },
        ): Promise<Require_id<TRawDocType>[]>;
        insertMany(
            docs: TRawDocType[],
            options: InsertManyOptions & { rawResult: true },
        ): Promise<InsertManyResult<Require_id<THydratedDocumentType>>>;
        insertMany<DocContents = TRawDocType>(
            docs: (TRawDocType | DocContents)[],
            options: InsertManyOptions & { lean: true },
        ): Promise<Require_id<DocContents>[]>;
        insertMany<DocContents = TRawDocType>(
            docs: (TRawDocType | DocContents)[],
            options: InsertManyOptions & { rawResult: true },
        ): Promise<InsertManyResult<Require_id<DocContents>>>;
        insertMany<DocContents = TRawDocType>(
            doc: DocContents,
            options: InsertManyOptions & { lean: true },
        ): Promise<Require_id<DocContents>[]>;
        insertMany<DocContents = TRawDocType>(
            doc: DocContents,
            options: InsertManyOptions & { rawResult: true },
        ): Promise<InsertManyResult<Require_id<DocContents>>>;
        insertMany(
            doc: TRawDocType[],
            options: InsertManyOptions,
        ): Promise<THydratedDocumentType[]>;
        insertMany<DocContents = TRawDocType>(
            docs: (TRawDocType | DocContents)[],
        ): Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>;
        insertMany<DocContents = TRawDocType>(
            doc: DocContents,
            options: InsertManyOptions,
        ): Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>;
        insertMany<DocContents = TRawDocType>(
            docs: (TRawDocType | DocContents)[],
            options: InsertManyOptions,
        ): Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>;
        insertMany<DocContents = TRawDocType>(
            doc: DocContents,
        ): Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>;
        insertOne(
            doc: Partial<ApplyBasicCreateCasting<TRawDocType>>,
            options?: SaveOptions,
        ): Promise<THydratedDocumentType>;
        listenerCount<E extends string | symbol>(
            eventName: string | symbol,
            listener?: (...args: any[]) => void,
        ): number;
        listeners<E extends string | symbol>(
            eventName: string | symbol,
        ): ((...args: any[]) => void)[];
        listIndexes(): Promise<any[]>;
        listSearchIndexes(
            options?: ListSearchIndexesOptions,
        ): Promise<{ name: string }[]>;
        off<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        on<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        once<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        populate(
            docs: any[],
            options: string | PopulateOptions | PopulateOptions[],
        ): Promise<THydratedDocumentType[]>;
        populate(
            doc: any,
            options: string | PopulateOptions | PopulateOptions[],
        ): Promise<THydratedDocumentType>;
        populate<Paths>(
            docs: any[],
            options: string | PopulateOptions | PopulateOptions[],
        ): Promise<MergeType<THydratedDocumentType, Paths>[]>;
        populate<Paths>(
            doc: any,
            options: string | PopulateOptions | PopulateOptions[],
        ): Promise<MergeType<THydratedDocumentType, Paths>>;
        prependListener<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        prependOnceListener<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        rawListeners<E extends string | symbol>(
            eventName: string | symbol,
        ): ((...args: any[]) => void)[];
        recompileSchema(): void;
        removeAllListeners<E extends string | symbol>(
            eventName?: string | symbol,
        ): this;
        removeListener<E extends string | symbol>(
            eventName: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        replaceOne<ResultDoc = THydratedDocumentType>(
            filter?: QueryFilter<TRawDocType>,
            replacement?: AnyObject | TRawDocType,
            options?: ReplaceOptions & QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "replaceOne",
            TInstanceMethods & TVirtuals,
        >;
        replaceOne<ResultDoc = THydratedDocumentType>(
            filter?: Query<any, any, {}, unknown, "find", Record<string, never>>,
            replacement?: AnyObject | TRawDocType,
            options?: ReplaceOptions & QueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "replaceOne",
            TInstanceMethods & TVirtuals,
        >;
        setMaxListeners(n: number): this;
        startSession(options?: ClientSessionOptions): Promise<ClientSession>;
        syncIndexes(options?: SyncIndexesOptions): Promise<string[]>;
        translateAliases(raw: any): any;
        updateMany(
            filter: QueryFilter<TRawDocType>,
            update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>,
            options?: UpdateOptions & MongooseUpdateQueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "updateMany",
            TInstanceMethods & TVirtuals,
        >;
        updateMany(
            filter: Query<any, any>,
            update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>,
            options?: UpdateOptions & MongooseUpdateQueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "updateMany",
            TInstanceMethods & TVirtuals,
        >;
        updateOne(
            filter: QueryFilter<TRawDocType>,
            update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>,
            options?: UpdateOptions & MongooseUpdateQueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "updateOne",
            TInstanceMethods & TVirtuals,
        >;
        updateOne(
            filter: Query<any, any>,
            update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>,
            options?: UpdateOptions & MongooseUpdateQueryOptions<TRawDocType> | null,
        ): QueryWithHelpers<
            UpdateWriteOpResult,
            THydratedDocumentType,
            TQueryHelpers,
            TRawDocType,
            "updateOne",
            TInstanceMethods & TVirtuals,
        >;
        updateSearchIndex(name: string, definition: AnyObject): Promise<void>;
        useConnection(connection: Connection): this;
        validate(): Promise<void>;
        validate(obj: any): Promise<void>;
        validate(obj: any, pathsOrOptions: PathsToValidate): Promise<void>;
        validate(
            obj: any,
            pathsOrOptions: { pathsToSkip?: pathsToSkip },
        ): Promise<void>;
        watch<
            ResultType extends Document = any,
            ChangeType extends ChangeStreamDocument<Document> = any,
        >(
            pipeline?: Record<string, unknown>[],
            options?: ChangeStreamOptions & { hydrate?: boolean },
        ): ChangeStream<ResultType, ChangeType>;
        where<ResultDoc = THydratedDocumentType>(
            path: string,
            val?: any,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType[] : ResultDoc[],
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods,
        >;
        where<ResultDoc = THydratedDocumentType>(
            obj: object,
        ): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType[] : ResultDoc[],
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
        where<ResultDoc = THydratedDocumentType>(): QueryWithHelpers<
            HasLeanOption<TSchema> extends true ? TRawDocType[] : ResultDoc[],
            ResultDoc,
            TQueryHelpers,
            TRawDocType,
            "find",
            TInstanceMethods & TVirtuals,
        >;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    base baseModelName collection db discriminators events modelName schema

    Methods

    [captureRejectionSymbol]? $where addListener aggregate aggregation applyDefaults applyTimestamps applyVirtuals bulkSave bulkWrite castObject cleanIndexes clientEncryption countDocuments create createCollection createIndexes createSearchIndex createSearchIndexes deleteMany deleteOne diffIndexes discriminator distinct dropSearchIndex emit ensureIndexes estimatedDocumentCount eventNames exists find findById findByIdAndDelete findByIdAndUpdate findOne findOneAndDelete findOneAndReplace findOneAndUpdate getMaxListeners hydrate init insertMany insertOne listenerCount listeners listIndexes listSearchIndexes off on once populate prependListener prependOnceListener rawListeners recompileSchema removeAllListeners removeListener replaceOne setMaxListeners startSession syncIndexes translateAliases updateMany updateOne updateSearchIndex useConnection validate watch where

    Constructors

    Properties

    base: __module

    Base Mongoose instance the model uses.

    baseModelName: string | undefined

    If this is a discriminator model, baseModelName is the name of the base model.

    collection: Collection

    Collection the model uses.

    db: Connection

    Connection the model uses.

    discriminators:
        | { [name: string]: Model<any, {}, {}, {}, any, any, any> }
        | undefined

    Registered discriminators for this model.

    events: EventEmitter

    Event emitter that reports any errors that occurred. Useful for global error handling.

    modelName: string

    The name of the model

    schema: TSchema

    Schema the model uses.

    Methods

    • The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

      import { EventEmitter, captureRejectionSymbol } from 'node:events';

      class MyClass extends EventEmitter {
        constructor() {
          super({ captureRejections: true });
        }

        [captureRejectionSymbol](err, event, ...args) {
          console.log('rejection happened for', event, 'with', err, ...args);
          this.destroy(err);
        }

        destroy(err) {
          // Tear the resource down here.
        }
      }

      Parameters

      • error: Error
      • event: string | symbol
      • ...args: any[]

      Returns void

      v13.4.0, v12.16.0

    • Alias for emitter.on(eventName, listener).

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • Type Parameters

      • R = any

      Parameters

      • Optionalpipeline: PipelineStage[]
      • Optionaloptions: AggregateOptions

      Returns Aggregate<R[]>

    • Type Parameters

      • R = any

      Parameters

      • pipeline: PipelineStage[]

      Returns Aggregate<R[]>

    • Parameters

      • obj: AnyObject

      Returns AnyObject

    • Parameters

      Returns TRawDocType

    • Apply this model's timestamps to a given POJO, including subdocument timestamps

      Parameters

      • obj: AnyObject
      • Optionaloptions: { currentTime?: () => Date; isUpdate?: boolean }

      Returns AnyObject

    • Parameters

      • obj: AnyObject
      • OptionalvirtalsToApply: string[]

      Returns AnyObject

    • Sends multiple save() calls in a single bulkWrite(). This is faster than sending multiple save() calls because with bulkSave() there is only one network round trip to the MongoDB server.

      Parameters

      • documents: Document<ObjectId, any, any, Record<string, any>, {}>[]
      • Optionaloptions: MongooseBulkSaveOptions

      Returns Promise<MongooseBulkWriteResult>

    • Sends multiple insertOne, updateOne, updateMany, replaceOne, deleteOne, and/or deleteMany operations to the MongoDB server in one command. This is faster than sending multiple independent operations (e.g. if you use create()) because with bulkWrite() there is only one network round trip to the MongoDB server.

      Type Parameters

      Parameters

      • writes: AnyBulkWriteOperation<
            DocContents extends Document ? DocContents<DocContents> : any,
        >[]
      • options: BulkWriteOptions & MongooseBulkWriteOptions & { ordered: false }

      Returns Promise<BulkWriteResult & { mongoose?: { validationErrors: Error[] } }>

    • Type Parameters

      Parameters

      Returns Promise<BulkWriteResult>

    • Parameters

      • obj: AnyObject
      • Optionaloptions: { ignoreCastErrors?: boolean }

      Returns TRawDocType

    • Parameters

      • Optionaloptions: { hideIndexes?: boolean; toDrop?: string[] }

      Returns Promise<string[]>

    • If auto encryption is enabled, returns a ClientEncryption instance that is configured with the same settings that Mongoose's underlying MongoClient is using. If the client has not yet been configured, returns null.

      Returns ClientEncryption | null

    • Creates a countDocuments query: counts the number of documents that match filter.

      Parameters

      • Optionalfilter: QueryFilter<TRawDocType>
      • Optionaloptions:
            | CountOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any } & Abortable
            | null

      Returns QueryWithHelpers<
          number,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "countDocuments",
          TInstanceMethods & TVirtuals,
      >

    • Parameters

      • Optionalfilter: Query<any, any, {}, unknown, "find", Record<string, never>>
      • Optionaloptions:
            | CountOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any } & Abortable
            | null

      Returns QueryWithHelpers<
          number,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "countDocuments",
          TInstanceMethods & TVirtuals,
      >

    • Creates a new document or documents

      Returns Promise<null>

    • Parameters

      • doc: Partial<TRawDocType>

      Returns Promise<THydratedDocumentType>

    • Parameters

      Returns Promise<THydratedDocumentType[]>

    • Parameters

      • docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[]
      • options: CreateOptions & { aggregateErrors: true }

      Returns Promise<(THydratedDocumentType | Error)[]>

    • Parameters

      • docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[]
      • Optionaloptions: CreateOptions

      Returns Promise<THydratedDocumentType[]>

    • Parameters

      • doc: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>

      Returns Promise<THydratedDocumentType>

    • Parameters

      • ...docs: DeepPartial<ApplyBasicCreateCasting<Require_id<TRawDocType>>>[]

      Returns Promise<THydratedDocumentType[]>

    • Create the collection for this model. By default, if no indexes are specified, mongoose will not create the collection for the model until any documents are created. Use this method to create the collection explicitly.

      Type Parameters

      • T extends Document

      Parameters

      • Optionaloptions: CreateCollectionOptions & Pick<
            SchemaOptions<
                unknown,
                {},
                {},
                {},
                {},
                Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                    _id: ObjectId;
                } & { __v: number } & { id: string },
                Model<
                    unknown,
                    {},
                    {},
                    {},
                    Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                        _id: ObjectId;
                    } & { __v: number } & { id: string },
                    any,
                    unknown,
                >,
            >,
            "expires",
        >

      Returns Promise<Collection<T>>

    • Similar to ensureIndexes(), except for it uses the createIndex function.

      Parameters

      • Optionaloptions: CreateIndexesOptions

      Returns Promise<void>

    • Create an Atlas search index. This function only works when connected to MongoDB Atlas.

      Parameters

      • description: SearchIndexDescription

      Returns Promise<string>

    • Creates all Atlas search indexes defined in this model's schema. This function only works when connected to MongoDB Atlas.

      Returns Promise<string[]>

    • Deletes all of the documents that match conditions from the collection. Behaves like remove(), but deletes all documents that match conditions regardless of the single option.

      Parameters

      • Optionalfilter: QueryFilter<TRawDocType>
      • Optionaloptions:
            | DeleteOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any }
            | null

      Returns QueryWithHelpers<
          DeleteResult,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "deleteMany",
          TInstanceMethods & TVirtuals,
      >

    • Parameters

      • Optionalfilter: Query<any, any, {}, unknown, "find", Record<string, never>>
      • Optionaloptions:
            | DeleteOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any }
            | null

      Returns QueryWithHelpers<
          DeleteResult,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "deleteMany",
          TInstanceMethods & TVirtuals,
      >

    • Deletes the first document that matches conditions from the collection. Behaves like remove(), but deletes at most one document regardless of the single option.

      Parameters

      • Optionalfilter: QueryFilter<TRawDocType>
      • Optionaloptions:
            | DeleteOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any }
            | null

      Returns QueryWithHelpers<
          DeleteResult,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "deleteOne",
          TInstanceMethods & TVirtuals,
      >

    • Parameters

      • Optionalfilter: Query<any, any, {}, unknown, "find", Record<string, never>>
      • Optionaloptions:
            | DeleteOptions & Pick<
                QueryOptions<TRawDocType>,
                MongooseBaseQueryOptionKeys | "timestamps" | "lean",
            > & { [other: string]: any }
            | null

      Returns QueryWithHelpers<
          DeleteResult,
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "deleteOne",
          TInstanceMethods & TVirtuals,
      >

    • Does a dry-run of Model.syncIndexes(), meaning that the result of this function would be the result of Model.syncIndexes().

      Parameters

      • Optionaloptions: Record<string, unknown>

      Returns Promise<IndexesDiff>

    • Adds a discriminator type.

      Type Parameters

      • TDiscriminatorSchema extends Schema<
            any,
            any,
            {},
            {},
            {},
            {},
            DefaultSchemaOptions,
            { [key: number]: unknown; [key: symbol]: unknown; [key: string]: unknown },
            Document<
                unknown,
                {},
                { [key: number]: unknown; [key: symbol]: unknown; [key: string]: unknown },
                { id: string },
                ResolveSchemaOptions<DefaultSchemaOptions>,
            > & Omit<
                {
                    [key: number]: unknown;
                    [key: symbol]: unknown;
                    [key: string]: unknown;
                } & Required<{ _id: unknown }> & { __v: number },
                "id",
            > & { id: string },

                | { [path: string]: SchemaDefinitionProperty<undefined, any, any> }
                | {
                    [key: string]:
                        | SchemaDefinitionProperty<
                            any,
                            any,
                            Document<
                                unknown,
                                {},
                                {
                                    [key: number]: unknown;
                                    [key: symbol]: unknown;
                                    [key: string]: unknown;
                                },
                                { id: string },
                                ResolveSchemaOptions<DefaultSchemaOptions>,
                            > & Omit<
                                {
                                    [key: number]: unknown;
                                    [key: symbol]: unknown;
                                    [key: string]: unknown;
                                } & Required<{ _id: unknown }> & { __v: number },
                                "id",
                            > & { id: string },
                        >
                        | undefined;
                },
            { [key: number]: {}; [key: symbol]: {}; [key: string]: {} } & Required<
                { _id: unknown },
            > & { __v: number },
        >

      Parameters

      • name: string | number
      • schema: TDiscriminatorSchema
      • Optionalvalue: string | number | ObjectId | DiscriminatorOptions

      Returns Model<
          TRawDocType & IfAny<
              TDiscriminatorSchema,
              any,
              ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
          >,
          TQueryHelpers & ObtainSchemaGeneric<TDiscriminatorSchema, "TQueryHelpers">,
          TInstanceMethods & ObtainSchemaGeneric<
              TDiscriminatorSchema,
              "TInstanceMethods",
          >,
          TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
          IfAny<
              TRawDocType & IfAny<
                  TDiscriminatorSchema,
                  any,
                  ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
              >,
              any,
              (
                  TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                      TDiscriminatorSchema,
                      "TInstanceMethods",
                  >
              ) extends Record<string, never>
                  ? Document<
                      unknown,
                      TQueryHelpers & ObtainSchemaGeneric<
                          TDiscriminatorSchema,
                          "TQueryHelpers",
                      >,
                      TRawDocType & IfAny<
                          TDiscriminatorSchema,
                          any,
                          ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                      >,
                      TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                      DefaultSchemaOptions,
                  > & Require_id<
                      TRawDocType & IfAny<
                          TDiscriminatorSchema,
                          any,
                          ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                      >,
                  > & { __v: number } & AddDefaultId<
                      TRawDocType & IfAny<
                          TDiscriminatorSchema,
                          any,
                          ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                      >,
                      {},
                      DefaultSchemaOptions,
                  >
                  : IfAny<
                      TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                          TDiscriminatorSchema,
                          "TInstanceMethods",
                      >,
                      Document<
                          unknown,
                          TQueryHelpers & ObtainSchemaGeneric<
                              TDiscriminatorSchema,
                              "TQueryHelpers",
                          >,
                          TRawDocType & IfAny<
                              TDiscriminatorSchema,
                              any,
                              ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                          >,
                          TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                          DefaultSchemaOptions,
                      > & Require_id<
                          TRawDocType & IfAny<
                              TDiscriminatorSchema,
                              any,
                              ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                          >,
                      > & { __v: number },
                      Document<
                          unknown,
                          TQueryHelpers & ObtainSchemaGeneric<
                              TDiscriminatorSchema,
                              "TQueryHelpers",
                          >,
                          TRawDocType & IfAny<
                              TDiscriminatorSchema,
                              any,
                              ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
                          >,
                          TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">,
                          DefaultSchemaOptions,
                      > & Omit<
                          Require_id<TRawDocType & IfAny<(...), (...), (...)>> & {
                              __v: number;
                          },
                          | keyof TVirtuals
                          | keyof ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals">
                          | keyof TInstanceMethods
                          | keyof ObtainSchemaGeneric<TDiscriminatorSchema, "TInstanceMethods">,
                      > & TVirtuals & ObtainSchemaGeneric<TDiscriminatorSchema, "TVirtuals"> & TInstanceMethods & ObtainSchemaGeneric<
                          TDiscriminatorSchema,
                          "TInstanceMethods",
                      >,
                  >,
          >,
          any,
          TRawDocType & IfAny<
              TDiscriminatorSchema,
              any,
              ObtainSchemaGeneric<TDiscriminatorSchema, "DocType">,
          >,
      > & ObtainSchemaGeneric<TSchema, "TStaticMethods"> & ObtainSchemaGeneric<
          TDiscriminatorSchema,
          "TStaticMethods",
      >

    • Type Parameters

      • D

      Parameters

      • name: string | number
      • schema: Schema
      • Optionalvalue: string | number | ObjectId | DiscriminatorOptions

      Returns Model<D>

    • Type Parameters

      • T
      • U

      Parameters

      • name: string | number
      • schema: Schema<T, U>
      • Optionalvalue: string | number | ObjectId | DiscriminatorOptions

      Returns U

    • Creates a distinct query: returns the distinct values of the given field that match filter.

      Type Parameters

      • DocKey extends string

      Parameters

      Returns QueryWithHelpers<
          (
              DocKey extends keyof WithLevel1NestedPaths<
                  TRawDocType,
                  keyof TRawDocType,
              >
                  ? WithoutUndefined<
                      Unpacked<
                          WithLevel1NestedPaths<TRawDocType, keyof TRawDocType>[DocKey<DocKey>],
                      >,
                  >
                  : unknown
          )[],
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "distinct",
          TInstanceMethods & TVirtuals,
      >

    • Type Parameters

      • DocKey extends string

      Parameters

      • field: DocKey
      • Optionalfilter: Query<any, any, {}, unknown, "find", Record<string, never>>
      • Optionaloptions: QueryOptions<TRawDocType>

      Returns QueryWithHelpers<
          (
              DocKey extends keyof WithLevel1NestedPaths<
                  TRawDocType,
                  keyof TRawDocType,
              >
                  ? WithoutUndefined<
                      Unpacked<
                          WithLevel1NestedPaths<TRawDocType, keyof TRawDocType>[DocKey<DocKey>],
                      >,
                  >
                  : unknown
          )[],
          THydratedDocumentType,
          TQueryHelpers,
          TRawDocType,
          "distinct",
          TInstanceMethods & TVirtuals,
      >

    • Delete an existing Atlas search index by name. This function only works when connected to MongoDB Atlas.

      Parameters

      • name: string

      Returns Promise<void>

    • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

      Returns true if the event had listeners, false otherwise.

      import { EventEmitter } from 'node:events';
      const myEmitter = new EventEmitter();

      // First listener
      myEmitter.on('event', function firstListener() {
        console.log('Helloooo! first listener');
      });
      // Second listener
      myEmitter.on('event', function secondListener(arg1, arg2) {
        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
      });
      // Third listener
      myEmitter.on('event', function thirdListener(...args) {
        const parameters = args.join(', ');
        console.log(`event with parameters ${parameters} in third listener`);
      });

      console.log(myEmitter.listeners('event'));

      myEmitter.emit('event', 1, 2, 3, 4, 5);

      // Prints:
      // [
      //   [Function: firstListener],
      //   [Function: secondListener],
      //   [Function: thirdListener]
      // ]
      // Helloooo! first listener
      // event with parameters 1, 2 in second listener
      // event with parameters 1, 2, 3, 4, 5 in third listener

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • ...args: any[]

      Returns boolean

      v0.1.26

    • Sends createIndex commands to mongo for each index declared in the schema. The createIndex commands are sent in series.

      Parameters

      • Optionaloptions: CreateIndexesOptions

      Returns Promise<void>

    • Returns an array listing the events for which the emitter has registered listeners.

      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]

      Returns (string | symbol)[]

      v6.0.0

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

      Returns number

      v1.0.0

    • Shortcut for creating a new Document from existing raw data, pre-saved in the DB. The document returned has no paths marked as modified initially.

      Parameters

      • obj: any
      • Optionalprojection: ProjectionType<TRawDocType>
      • Optionaloptions: HydrateOptions

      Returns THydratedDocumentType

    • Inserts one or more new documents as a single insertMany call to the MongoDB server.

      Parameters

      Returns Promise<THydratedDocumentType[]>

    • Parameters

      • doc: TRawDocType[]
      • options: InsertManyOptions & { ordered: false; rawResult: true }

      Returns Promise<
          InsertManyResult<Require_id<TRawDocType>> & {
              mongoose: {
                  results: (Object | THydratedDocumentType | Error)[];
                  validationErrors: (CastError | ValidatorError)[];
              };
          },
      >

    • Parameters

      • docs: TRawDocType[]
      • options: InsertManyOptions & { lean: true; rawResult: true }

      Returns Promise<InsertManyResult<Require_id<TRawDocType>>>

    • Type Parameters

      Parameters

      Returns Promise<
          InsertManyResult<Require_id<DocContents>> & {
              mongoose: {
                  results: (
                      Object
                      | Error
                      | MergeType<THydratedDocumentType, DocContents>
                  )[];
                  validationErrors: (CastError | ValidatorError)[];
              };
          },
      >

    • Parameters

      • docs: TRawDocType[]
      • options: InsertManyOptions & { lean: true }

      Returns Promise<Require_id<TRawDocType>[]>

    • Parameters

      • docs: TRawDocType[]
      • options: InsertManyOptions & { rawResult: true }

      Returns Promise<InsertManyResult<Require_id<THydratedDocumentType>>>

    • Type Parameters

      Parameters

      Returns Promise<Require_id<DocContents>[]>

    • Type Parameters

      Parameters

      Returns Promise<InsertManyResult<Require_id<DocContents>>>

    • Type Parameters

      Parameters

      • doc: DocContents
      • options: InsertManyOptions & { lean: true }

      Returns Promise<Require_id<DocContents>[]>

    • Type Parameters

      Parameters

      • doc: DocContents
      • options: InsertManyOptions & { rawResult: true }

      Returns Promise<InsertManyResult<Require_id<DocContents>>>

    • Parameters

      Returns Promise<THydratedDocumentType[]>

    • Type Parameters

      Parameters

      Returns Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>

    • Type Parameters

      Parameters

      Returns Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>

    • Type Parameters

      Parameters

      Returns Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>

    • Type Parameters

      Parameters

      Returns Promise<MergeType<THydratedDocumentType, Omit<DocContents, "_id">>[]>

    • Shortcut for saving one document to the database. MyModel.insertOne(obj, options) is almost equivalent to new MyModel(obj).save(options). The difference is that insertOne() checks if obj is already a document, and checks for discriminators.

      Parameters

      • doc: Partial<ApplyBasicCreateCasting<TRawDocType>>
      • Optionaloptions: SaveOptions

      Returns Promise<THydratedDocumentType>

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

      • Optionallistener: (...args: any[]) => void

        The event handler function

      Returns number

      v3.2.0

    • Returns a copy of the array of listeners for the event named eventName.

      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v0.1.26

    • Lists the indexes currently defined in MongoDB. This may or may not be the same as the indexes defined in your schema depending on whether you use the autoIndex option and if you build indexes manually.

      Returns Promise<any[]>

    • List all Atlas search indexes on this model's collection. This function only works when connected to MongoDB Atlas.

      Parameters

      • Optionaloptions: ListSearchIndexesOptions

      Returns Promise<{ name: string }[]>

    • Alias for emitter.removeListener().

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v10.0.0

    • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

      server.on('connection', (stream) => {
        console.log('someone connected!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.on('foo', () => console.log('a'));
      myEE.prependListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v0.1.101

    • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

      server.once('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.once('foo', () => console.log('a'));
      myEE.prependOnceListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v0.3.0

    • Populates document references.

      Parameters

      • docs: any[]
      • options: string | PopulateOptions | PopulateOptions[]

      Returns Promise<THydratedDocumentType[]>

    • Parameters

      • doc: any
      • options: string | PopulateOptions | PopulateOptions[]

      Returns Promise<THydratedDocumentType>

    • Type Parameters

      • Paths

      Parameters

      • docs: any[]
      • options: string | PopulateOptions | PopulateOptions[]

      Returns Promise<MergeType<THydratedDocumentType, Paths>[]>

    • Type Parameters

      • Paths

      Parameters

      • doc: any
      • options: string | PopulateOptions | PopulateOptions[]

      Returns Promise<MergeType<THydratedDocumentType, Paths>>

    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

      server.prependListener('connection', (stream) => {
        console.log('someone connected!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

      server.prependOnceListener('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: (...args: any[]) => void

        The callback function

      Returns this

      v6.0.0

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol

      Returns ((...args: any[]) => void)[]

      v9.4.0

    • Apply changes made to this model's schema after this model was compiled.

      Returns void

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • OptionaleventName: string | symbol

      Returns this

      v0.1.26

    • Removes the specified listener from the listener array for the event named eventName.

      const callback = (stream) => {
        console.log('someone connected!');
      };
      server.on('connection', callback);
      // ...
      server.removeListener('connection', callback);

      removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

      Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

      import { EventEmitter } from 'node:events';
      class MyEmitter extends EventEmitter {}
      const myEmitter = new MyEmitter();

      const callbackA = () => {
        console.log('A');
        myEmitter.removeListener('event', callbackB);
      };

      const callbackB = () => {
        console.log('B');
      };

      myEmitter.on('event', callbackA);

      myEmitter.on('event', callbackB);

      // callbackA removes listener callbackB but it will still be called.
      // Internal listener array at time of emit [callbackA, callbackB]
      myEmitter.emit('event');
      // Prints:
      //   A
      //   B

      // callbackB is now removed.
      // Internal listener array [callbackA]
      myEmitter.emit('event');
      // Prints:
      //   A

      Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

      When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

      import { EventEmitter } from 'node:events';
      const ee = new EventEmitter();

      function pong() {
        console.log('pong');
      }

      ee.on('ping', pong);
      ee.once('ping', pong);
      ee.removeListener('ping', pong);

      ee.emit('ping');
      ee.emit('ping');

      Returns a reference to the EventEmitter, so that calls can be chained.

      Type Parameters

      • E extends string | symbol

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void

      Returns this

      v0.1.26

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      Parameters

      • n: number

      Returns this

      v0.3.5

    • Starts a MongoDB session for benefits like causal consistency, retryable writes, and transactions.

      Parameters

      • Optionaloptions: ClientSessionOptions

      Returns Promise<ClientSession>

    • Makes the indexes in MongoDB match the indexes defined in this model's schema. This function will drop any indexes that are not defined in the model's schema except the _id index, and build any indexes that are in your schema but not in MongoDB.

      Parameters

      • Optionaloptions: SyncIndexesOptions

      Returns Promise<string[]>

    • Translate any aliases fields/conditions so the final query or document object is pure

      Parameters

      • raw: any

      Returns any

    • Update an existing Atlas search index. This function only works when connected to MongoDB Atlas.

      Parameters

      • name: string
      • definition: AnyObject

      Returns Promise<void>

    • Changes the Connection instance this model uses to make requests to MongoDB. This function is most useful for changing the Connection that a Model defined using mongoose.model() uses after initialization.

      Parameters

      • connection: Connection

      Returns this

    • Casts and validates the given object against this model's schema, passing the given context to custom validators.

      Returns Promise<void>

    • Parameters

      • obj: any

      Returns Promise<void>

    • Parameters

      • obj: any
      • pathsOrOptions: PathsToValidate

      Returns Promise<void>

    • Parameters

      • obj: any
      • pathsOrOptions: { pathsToSkip?: pathsToSkip }

      Returns Promise<void>

    • Watches the underlying collection for changes using MongoDB change streams.

      Type Parameters

      • ResultType extends Document = any
      • ChangeType extends ChangeStreamDocument<Document> = any

      Parameters

      • Optionalpipeline: Record<string, unknown>[]
      • Optionaloptions: ChangeStreamOptions & { hydrate?: boolean }

      Returns ChangeStream<ResultType, ChangeType>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    [captureRejectionSymbol]$whereaddListeneraggregateaggregationapplyDefaultsapplyTimestampsapplyVirtualsbulkSavebulkWritecastObjectcleanIndexesclientEncryptioncountDocumentscreatecreateCollectioncreateIndexescreateSearchIndexcreateSearchIndexesdeleteManydeleteOnediffIndexesdiscriminatordistinctdropSearchIndexemitensureIndexesestimatedDocumentCounteventNamesexistsfindfindByIdfindByIdAndDeletefindByIdAndUpdatefindOnefindOneAndDeletefindOneAndReplacefindOneAndUpdategetMaxListenershydrateinitinsertManyinsertOnelistenerCountlistenerslistIndexeslistSearchIndexesoffononcepopulateprependListenerprependOnceListenerrawListenersrecompileSchemaremoveAllListenersremoveListenerreplaceOnesetMaxListenersstartSessionsyncIndexestranslateAliasesupdateManyupdateOneupdateSearchIndexuseConnectionvalidatewatchwhere