Class Subdocument<IdType, TQueryHelpers, DocType>

constructor

• new Subdocument<IdType, TQueryHelpers, DocType>(doc?): mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>

• Type Parameters

  • IdType = any
  • TQueryHelpers = any
  • DocType = any

  Parameters

  • Optional doc: any

  Returns mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>

$locals

$op

$where

Optional __v

Optional _id

Optional baseModelName

collection

db

Optional errors

Optional id

isNew

schema

$assertPopulated

• $assertPopulated<Paths>(path, values?): Omit<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, keyof Paths> & Paths

• Assert that a given path or paths is populated. Throws an error if not populated.

  Type Parameters

  • Paths = {}

  Parameters

  • path: string | string[]
  • Optional values: Partial<Paths>

  Returns Omit<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, keyof Paths> & Paths

$clone

• $clone(): this

• Returns a deep clone of this document

  Returns this

$getAllSubdocs

• $getAllSubdocs(): mongoose.Document<any, any, any>[]

• Returns mongoose.Document<any, any, any>[]

$getPopulatedDocs

• $getPopulatedDocs(): mongoose.Document<any, any, any>[]

• Returns an array of all populated documents associated with the query

  Returns mongoose.Document<any, any, any>[]

$ignore

• $ignore(path): void

• Don't run validation on this path or persist changes to this path.

  Parameters

  • path: string

  Returns void

$inc

• $inc(path, val?): this

• Increments the numeric value at path by the given val. When you call save() on this document, Mongoose will send a $inc as opposed to a $set.

  Parameters

  • path: string | string[]
  • Optional val: number

  Returns this

$isDefault

• $isDefault(path): boolean

• Checks if a path is set to its default.

  Parameters

  • path: string

  Returns boolean

$isDeleted

• $isDeleted(val?): boolean

• Getter/setter, determines whether the document was removed or not.

  Parameters

  • Optional val: boolean

  Returns boolean

$isEmpty

• $isEmpty(path): boolean

• Returns true if the given path is nullish or only contains empty objects. Useful for determining whether this subdoc will get stripped out by the minimize option.

  Parameters

  • path: string

  Returns boolean

$isValid

• $isValid(path): boolean

• Checks if a path is invalid

  Parameters

  • path: string

  Returns boolean

$markValid

• $markValid(path): void

• Marks a path as valid, removing existing validation errors.

  Parameters

  • path: string

  Returns void

$model

• $model<ModelType>(name): ModelType

• Returns the model with the given name on this document's associated connection.

  Type Parameters

  • ModelType = mongoose.Model<unknown, {}, {}, {}, mongoose.Document<unknown, {}, unknown> & Required<{
        _id: unknown;
    }>, any>

  Parameters

  • name: string

  Returns ModelType
• $model<ModelType>(): ModelType

• Type Parameters

  • ModelType = mongoose.Model<DocType, {}, {}, {}, IfAny<DocType, any, mongoose.Document<unknown, {}, DocType> & Require_id<DocType>>, any>

  Returns ModelType

$session

• $session(session?): mongoose.mongo.ClientSession

• Getter/setter around the session associated with this document. Used to automatically set session if you save() a doc that you got from a query with an associated session.

  Parameters

  • Optional session: mongoose.mongo.ClientSession

  Returns mongoose.mongo.ClientSession

$set

• $set(path, val, type, options?): this

• Alias for set(), used internally to avoid conflicts

  Parameters

  • path: string | Record<string, any>
  • val: any
  • type: any
  • Optional options: DocumentSetOptions

  Returns this
• $set(path, val, options?): this

• Parameters

  • path: string | Record<string, any>
  • val: any
  • Optional options: DocumentSetOptions

  Returns this

• $set(value): this

• Parameters

  • value: string | Record<string, any>

  Returns this

deleteOne

• deleteOne(options?): Promise<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

• Removes this document from the db.

  Parameters

  • Optional options: mongoose.QueryOptions<unknown>

  Returns Promise<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

depopulate

• depopulate(path?): this

• Takes a populated field and returns it to its unpopulated state. If called with no arguments, then all populated fields are returned to their unpopulated state.

  Parameters

  • Optional path: string | string[]

  Returns this

directModifiedPaths

• directModifiedPaths(): string[]

• Returns the list of paths that have been directly modified. A direct modified path is a path that you explicitly set, whether via doc.foo = 'bar', Object.assign(doc, { foo: 'bar' }), or doc.set('foo', 'bar').

  Returns string[]

equals

• equals(doc): boolean

• Returns true if this document is equal to another document.

  Documents are considered equal when they have matching _ids, unless neither document has an _id, in which case this function falls back to using deepEqual().

  Parameters

  • doc: mongoose.Document<IdType, any, any>

  Returns boolean

get

• get<T>(path, type?, options?): DocType[T]

• Returns the value of a path.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T
  • Optional type: any
  • Optional options: any

  Returns DocType[T]
• get(path, type?, options?): any

• Parameters

  • path: string
  • Optional type: any
  • Optional options: any

  Returns any

getChanges

• getChanges(): UpdateQuery<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

• Returns the changes that happened to the document in the format that will be sent to MongoDB.

  Returns UpdateQuery<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

increment

• increment(): this

• Signal that we desire an increment of this documents version.

  Returns this

init

• init(obj, opts?): this

• Initializes the document without setters or marking anything modified. Called internally after a document is returned from mongodb. Normally, you do not need to call this function on your own.

  Parameters

  • obj: AnyObject
  • Optional opts: AnyObject

  Returns this

invalidate

• invalidate<T>(path, errorMsg, value?, kind?): NativeError

• Marks a path as invalid, causing validation to fail.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T
  • errorMsg: string | NativeError
  • Optional value: any
  • Optional kind: string

  Returns NativeError
• invalidate(path, errorMsg, value?, kind?): NativeError

• Parameters

  • path: string
  • errorMsg: string | NativeError
  • Optional value: any
  • Optional kind: string

  Returns NativeError

isDirectModified

• isDirectModified<T>(path): boolean

• Returns true if path was directly set and modified, else false.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T | T[]

  Returns boolean
• isDirectModified(path): boolean

• Parameters

  • path: string | string[]

  Returns boolean

isDirectSelected

• isDirectSelected<T>(path): boolean

• Checks if path was explicitly selected. If no projection, always returns true.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T

  Returns boolean
• isDirectSelected(path): boolean

• Parameters

  • path: string

  Returns boolean

isInit

• isInit<T>(path): boolean

• Checks if path is in the init state, that is, it was set by Document#init() and not modified since.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T

  Returns boolean
• isInit(path): boolean

• Parameters

  • path: string

  Returns boolean

isModified

• isModified<T>(path?, options?): boolean

• Returns true if any of the given paths are modified, else false. If no arguments, returns true if any path in this document is modified.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • Optional path: T | T[]
  • Optional options: {
        ignoreAtomics?: boolean;
    }

    • Optional ignoreAtomics?: boolean

  Returns boolean
• isModified(path?, options?): boolean

• Parameters

  • Optional path: string | string[]
  • Optional options: {
        ignoreAtomics?: boolean;
    }

    • Optional ignoreAtomics?: boolean

  Returns boolean

isSelected

• isSelected<T>(path): boolean

• Checks if path was selected in the source query which initialized this document.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T

  Returns boolean
• isSelected(path): boolean

• Parameters

  • path: string

  Returns boolean

markModified

• markModified<T>(path, scope?): void

• Marks the path as having pending changes to write to the db.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T
  • Optional scope: any

  Returns void
• markModified(path, scope?): void

• Parameters

  • path: string
  • Optional scope: any

  Returns void

model

• model<ModelType>(name): ModelType

• Returns the model with the given name on this document's associated connection.

  Type Parameters

  • ModelType = mongoose.Model<unknown, {}, {}, {}, mongoose.Document<unknown, {}, unknown> & Required<{
        _id: unknown;
    }>, any>

  Parameters

  • name: string

  Returns ModelType
• model<ModelType>(): ModelType

• Type Parameters

  • ModelType = mongoose.Model<DocType, {}, {}, {}, IfAny<DocType, any, mongoose.Document<unknown, {}, DocType> & Require_id<DocType>>, any>

  Returns ModelType

modifiedPaths

• modifiedPaths(options?): string[]

• Returns the list of paths that have been modified.

  Parameters

  • Optional options: {
        includeChildren?: boolean;
    }

    • Optional includeChildren?: boolean

  Returns string[]

overwrite

• overwrite(obj): this

• Overwrite all values in this document with the values of obj, except for immutable properties. Behaves similarly to set(), except for it unsets all properties that aren't in obj.

  Parameters

  • obj: AnyObject

  Returns this

populate

• populate<Paths>(path): Promise<MergeType<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, Paths>>

• Populates document references.

  Type Parameters

  • Paths = {}

  Parameters

  • path: string | PopulateOptions | (string | PopulateOptions)[]

  Returns Promise<MergeType<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, Paths>>
• populate<Paths>(path, select?, model?, match?, options?): Promise<MergeType<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, Paths>>

• Type Parameters

  • Paths = {}

  Parameters

  • path: string
  • Optional select: string | AnyObject
  • Optional model: mongoose.Model<any, {}, {}, {}, any, any>
  • Optional match: AnyObject
  • Optional options: PopulateOptions

  Returns Promise<MergeType<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, Paths>>

populated

• populated(path): any

• Gets _id(s) used during population of the given path. If the path was not populated, returns undefined.

  Parameters

  • path: string

  Returns any

replaceOne

• replaceOne(replacement?, options?): Query<any, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, {}, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, "find">

• Sends a replaceOne command with this document _id as the query selector.

  Parameters

  • Optional replacement: AnyObject
  • Optional options: mongoose.QueryOptions<unknown>

  Returns Query<any, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, {}, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, "find">

save

• save(options?): Promise<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

• Saves this document by inserting a new document into the database if document.isNew is true, or sends an updateOne operation with just the modified paths if isNew is false.

  Parameters

  • Optional options: SaveOptions

  Returns Promise<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>

set

• set<T>(path, val, type, options?): this

• Sets the value of a path, or many paths.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T
  • val: DocType[T]
  • type: any
  • Optional options: DocumentSetOptions

  Returns this
• set(path, val, type, options?): this

• Parameters

  • path: string | Record<string, any>
  • val: any
  • type: any
  • Optional options: DocumentSetOptions

  Returns this

• set(path, val, options?): this

• Parameters

  • path: string | Record<string, any>
  • val: any
  • Optional options: DocumentSetOptions

  Returns this

• set(value): this

• Parameters

  • value: string | Record<string, any>

  Returns this

toJSON

• toJSON<T>(options?): FlattenMaps<T>

• The return value of this method is used in calls to JSON.stringify(doc).

  Type Parameters

  • T = Require_id<DocType>

  Parameters

  • Optional options: ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
        _id: unknown;
    }>> & {
        flattenMaps?: true;
    }

  Returns FlattenMaps<T>
• toJSON<T>(options): T

• Type Parameters

  • T = Require_id<DocType>

  Parameters

  • options: ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
        _id: unknown;
    }>> & {
        flattenMaps: false;
    }

  Returns T

toObject

• toObject<T>(options?): Require_id<T>

• Converts this document into a plain-old JavaScript object (POJO).

  Type Parameters

  • T = Require_id<DocType>

  Parameters

  • Optional options: ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{
        _id: unknown;
    }>>

  Returns Require_id<T>

unmarkModified

• unmarkModified<T>(path): void

• Clears the modified state on the specified path.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • path: T

  Returns void
• unmarkModified(path): void

• Parameters

  • path: string

  Returns void

updateOne

• updateOne(update?, options?): Query<any, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, {}, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, "find">

• Sends an updateOne command with this document _id as the query selector.

  Parameters

  • Optional update: UpdateWithAggregationPipeline | UpdateQuery<mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>>
  • Optional options: mongoose.QueryOptions<unknown>

  Returns Query<any, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, {}, mongoose.Types.Subdocument<IdType, TQueryHelpers, DocType>, "find">

validate

• validate<T>(pathsToValidate?, options?): Promise<void>

• Executes registered validation rules for this document.

  Type Parameters

  • T extends string | number | symbol

  Parameters

  • Optional pathsToValidate: T | T[]
  • Optional options: AnyObject

  Returns Promise<void>
• validate(pathsToValidate?, options?): Promise<void>

• Parameters

  • Optional pathsToValidate: PathsToValidate
  • Optional options: AnyObject

  Returns Promise<void>

• validate(options): Promise<void>

• Parameters

  • options: {
        pathsToSkip?: pathsToSkip;
    }

    • Optional pathsToSkip?: pathsToSkip

  Returns Promise<void>

validateSync

• validateSync(options): ValidationError

• Executes registered validation rules (skipping asynchronous validators) for this document.

  Parameters

  • options: {
        pathsToSkip?: pathsToSkip;
        [k: string]: any;
    }

    • [k: string]: any

    • Optional pathsToSkip?: pathsToSkip

  Returns ValidationError
• validateSync<T>(pathsToValidate?, options?): ValidationError

• Type Parameters

  • T extends string | number | symbol

  Parameters

  • Optional pathsToValidate: T | T[]
  • Optional options: AnyObject

  Returns ValidationError

• validateSync(pathsToValidate?, options?): ValidationError

• Parameters

  • Optional pathsToValidate: PathsToValidate
  • Optional options: AnyObject

  Returns ValidationError