Interface UserDocument

interface UserDocument {
    _id: string;
    $locals: Record<string, unknown>;
    $op: "save" | "validate" | "remove" | null;
    $where: Record<string, unknown>;
    baseModelName?: string;
    collection: Collection;
    createdAt: Date;
    db: Connection;
    errors?: ValidationError;
    isNew: boolean;
    password: string;
    role: UserRole;
    schema: Schema;
    updatedAt: Date;
    username: string;
    $assertPopulated<Paths = {}>(
        path: string | string[],
        values?: Partial<Paths>,
    ): Omit<UserDocument, keyof Paths> & Paths;
    $clearModifiedPaths(): this;
    $clone(): this;
    $createModifiedPathsSnapshot(): ModifiedPathsSnapshot;
    $getAllSubdocs(): Document<ObjectId, any, any, Record<string, any>, {}>[];
    $getPopulatedDocs(): Document<ObjectId, any, any, Record<string, any>, {}>[];
    $ignore(path: string): void;
    $inc(path: string | string[], val?: number): this;
    $isDefault(path?: string): boolean;
    $isDeleted(val?: boolean): boolean;
    $isEmpty(path: string): boolean;
    $isValid(path: string): boolean;
    $markValid(path: string): void;
    $model<
        ModelType extends
            Model<
                unknown,
                {},
                {},
                {},
                Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                    _id: ObjectId;
                } & { __v: number } & { id: string },
                any,
                unknown,
            >,
    >(
        name: string,
    ): ModelType;
    $model<ModelType extends Model<any, {}, {}, {}, any, any, any>>(): ModelType;
    $parent(): | Document<ObjectId, any, any, Record<string, any>, {}>
    | undefined;
    $restoreModifiedPathsSnapshot(snapshot: ModifiedPathsSnapshot): this;
    $session(session?: ClientSession | null): ClientSession | null;
    $set(
        path: string | Record<string, any>,
        val: any,
        type: any,
        options?: DocumentSetOptions,
    ): this;
    $set(
        path: string | Record<string, any>,
        val: any,
        options?: DocumentSetOptions,
    ): this;
    $set(value: string | Record<string, any>): this;
    deleteOne(options?: QueryOptions<unknown>): any;
    depopulate<Paths = {}>(
        path?: string | string[],
    ): MergeType<UserDocument, Paths>;
    directModifiedPaths(): string[];
    equals(doc: Document<string>): boolean;
    get<T extends string | number | symbol>(
        path: T,
        type?: any,
        options?: any,
    ): any;
    get(path: string, type?: any, options?: any): any;
    getChanges(): UpdateQuery<UserDocument>;
    increment(): this;
    init(obj: AnyObject, opts?: AnyObject): this;
    invalidate<T extends string | number | symbol>(
        path: T,
        errorMsg: string | NativeError,
        value?: any,
        kind?: string,
    ): NativeError | null;
    invalidate(
        path: string,
        errorMsg: string | NativeError,
        value?: any,
        kind?: string,
    ): NativeError | null;
    isDirectModified<T extends string | number | symbol>(
        path: T | T[],
    ): boolean;
    isDirectModified(path: string | string[]): boolean;
    isDirectSelected<T extends string | number | symbol>(path: T): boolean;
    isDirectSelected(path: string): boolean;
    isInit<T extends string | number | symbol>(path: T): boolean;
    isInit(path: string): boolean;
    isModified<T extends string | number | symbol>(
        path?: T | T[],
        options?: { ignoreAtomics?: boolean } | null,
    ): boolean;
    isModified(
        path?: string | string[],
        options?: { ignoreAtomics?: boolean } | null,
    ): boolean;
    isSelected<T extends string | number | symbol>(path: T): boolean;
    isSelected(path: string): boolean;
    markModified<T extends string | number | symbol>(
        path: T,
        scope?: any,
    ): void;
    markModified(path: string, scope?: any): void;
    model<
        ModelType extends
            Model<
                unknown,
                {},
                {},
                {},
                Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                    _id: ObjectId;
                } & { __v: number } & { id: string },
                any,
                unknown,
            >,
    >(
        name: string,
    ): ModelType;
    model<ModelType extends Model<any, {}, {}, {}, any, any, any>>(): ModelType;
    modifiedPaths(options?: { includeChildren?: boolean }): string[];
    overwrite(obj: AnyObject): this;
    populate<Paths = {}>(
        path: string | PopulateOptions | (string | PopulateOptions)[],
    ): Promise<MergeType<UserDocument, Paths>>;
    populate<Paths = {}>(
        path: string,
        select?: string | AnyObject,
        model?: Model<any, {}, {}, {}, any, any, any>,
        match?: AnyObject,
        options?: PopulateOptions,
    ): Promise<MergeType<UserDocument, Paths>>;
    populated(path: string): any;
    replaceOne(
        replacement?: AnyObject,
        options?: QueryOptions<unknown> | null,
    ): Query<any, UserDocument>;
    save(options?: SaveOptions): Promise<UserDocument>;
    set<T extends string | number | symbol>(
        path: T,
        val: any,
        type: any,
        options?: DocumentSetOptions,
    ): this;
    set(
        path: string | Record<string, any>,
        val: any,
        type: any,
        options?: DocumentSetOptions,
    ): this;
    set(
        path: string | Record<string, any>,
        val: any,
        options?: DocumentSetOptions,
    ): this;
    set(value: string | Record<string, any>): this;
    toBSON(): any;
    toJSON<
        O extends
            ToObjectOptions<
                unknown,
                Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                    _id: ObjectId;
                } & { __v: number } & { id: string },
            >,
    >(
        options: O,
    ): ApplyVersionKey<
        ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
            __v?: U;
        }
            ? { __v?: U } & ApplyFlattenTransforms<
                ApplyVirtuals<any, Record<string, any>, O>,
                O,
            >
            : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
                __v: number;
            },
        O,
        {},
    >;
    toJSON(
        options?: ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
    ): any;
    toJSON<T>(
        options?: ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
    ): Require_id<T> & { __v: number };
    toObject<
        O extends
            ToObjectOptions<
                unknown,
                Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                    _id: ObjectId;
                } & { __v: number } & { id: string },
            >,
    >(
        options: O,
    ): ApplyVersionKey<
        ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
            __v?: U;
        }
            ? { __v?: U } & ApplyFlattenTransforms<
                ApplyVirtuals<any, Record<string, any>, O>,
                O,
            >
            : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
                __v: number;
            },
        O,
        {},
    >;
    toObject(
        options?: ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
    ): any;
    toObject<T>(
        options?: ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
    ): Require_id<T> & { __v: number };
    unmarkModified<T extends string | number | symbol>(path: T): void;
    unmarkModified(path: string): void;
    updateOne(
        update?: UpdateWithAggregationPipeline | UpdateQuery<UserDocument>,
        options?: QueryOptions<unknown> | null,
    ): Query<any, UserDocument>;
    validate<T extends string | number | symbol>(
        pathsToValidate?: T | T[],
        options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
    ): Promise<void>;
    validate(
        pathsToValidate?: PathsToValidate,
        options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
    ): Promise<void>;
    validate(options: ValidateOptions): Promise<void>;
    validateSync(
        options: ValidateOptions & { [k: string]: any },
    ): ValidationError | null;
    validateSync<T extends string | number | symbol>(
        pathsToValidate?: T | T[],
        options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
    ): ValidationError | null;
    validateSync(
        pathsToValidate?: PathsToValidate,
        options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
    ): ValidationError | null;
}

Hierarchy

Document<string>
- UserDocument

Properties

`Readonly`_id

_id: string

This documents _id.

$locals

$locals: Record<string, unknown>

Empty object that you can use for storing properties on the document. This is handy for passing data to middleware without conflicting with Mongoose internals.

$op

$op: "save" | "validate" | "remove" | null

A string containing the current operation that Mongoose is executing on this document. Can be null, 'save', 'validate', or 'remove'.

$where

$where: Record<string, unknown>

Set this property to add additional query filters when Mongoose saves this document and isNew is false.

`Optional`baseModelName

baseModelName?: string

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

collection

collection: Collection

Collection the model uses.

`Readonly`createdAt

createdAt: Date

db

db: Connection

Connection the model uses.

`Optional`errors

errors?: ValidationError

Returns the current validation errors.

isNew

isNew: boolean

Boolean flag specifying if the document is new.

`Readonly`password

password: string

`Readonly`role

role: UserRole

schema

schema: Schema

The document's schema.

`Readonly`updatedAt

updatedAt: Date

`Readonly`username

username: string

Methods

$assertPopulated

$assertPopulated<Paths = {}>(
path: string | string[],
values?: Partial<Paths>,
): Omit<UserDocument, 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[]
- Optionalvalues: Partial<Paths>
Returns Omit<UserDocument, keyof Paths> & Paths
Inherited from Document.$assertPopulated
- Defined in node_modules/mongoose/types/document.d.ts:35

$clearModifiedPaths

$clearModifiedPaths(): this
Clear the document's modified paths.

Returns this
Inherited from Document.$clearModifiedPaths
- Defined in node_modules/mongoose/types/document.d.ts:38

$clone

$clone(): this
Returns a deep clone of this document

Returns this
Inherited from Document.$clone
- Defined in node_modules/mongoose/types/document.d.ts:41

$createModifiedPathsSnapshot

$createModifiedPathsSnapshot(): ModifiedPathsSnapshot
Creates a snapshot of this document's internal change tracking state. You can later reset this document's change tracking state using $restoreModifiedPathsSnapshot().

Returns ModifiedPathsSnapshot
Inherited from Document.$createModifiedPathsSnapshot
- Defined in node_modules/mongoose/types/document.d.ts:47

$getAllSubdocs

$getAllSubdocs(): Document<ObjectId, any, any, Record<string, any>, {}>[]
Returns Document<ObjectId, any, any, Record<string, any>, {}>[]
Inherited from Document.$getAllSubdocs
- Defined in node_modules/mongoose/types/document.d.ts:50

$getPopulatedDocs

$getPopulatedDocs(): Document<ObjectId, any, any, Record<string, any>, {}>[]
Returns an array of all populated documents associated with the query

Returns Document<ObjectId, any, any, Record<string, any>, {}>[]
Inherited from Document.$getPopulatedDocs
- Defined in node_modules/mongoose/types/document.d.ts:62

$ignore

$ignore(path: string): void
Don't run validation on this path or persist changes to this path.
Parameters
- path: string
Returns void
Inherited from Document.$ignore
- Defined in node_modules/mongoose/types/document.d.ts:53

$inc

$inc(path: string | string[], val?: number): 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[]
- Optionalval: number
Returns this
Inherited from Document.$inc
- Defined in node_modules/mongoose/types/document.d.ts:69

$isDefault

$isDefault(path?: string): boolean
Checks if a path is set to its default. If no path set, checks if any path is set to its default.
Parameters
- Optionalpath: string
Returns boolean
Inherited from Document.$isDefault
- Defined in node_modules/mongoose/types/document.d.ts:56

$isDeleted

$isDeleted(val?: boolean): boolean
Getter/setter, determines whether the document was removed or not.
Parameters
- Optionalval: boolean
Returns boolean
Inherited from Document.$isDeleted
- Defined in node_modules/mongoose/types/document.d.ts:59

$isEmpty

$isEmpty(path: string): 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
Inherited from Document.$isEmpty
- Defined in node_modules/mongoose/types/document.d.ts:76

$isValid

$isValid(path: string): boolean
Checks if a path is invalid
Parameters
- path: string
Returns boolean
Inherited from Document.$isValid
- Defined in node_modules/mongoose/types/document.d.ts:79

$markValid

$markValid(path: string): void
Marks a path as valid, removing existing validation errors.
Parameters
- path: string
Returns void
Inherited from Document.$markValid
- Defined in node_modules/mongoose/types/document.d.ts:89

$model

$model<
    ModelType extends
        Model<
            unknown,
            {},
            {},
            {},
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
            any,
            unknown,
        >,
>(
    name: string,
): ModelType
Returns the model with the given name on this document's associated connection.
Type Parameters
- ModelType extends Model<
      unknown,
      {},
      {},
      {},
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
      any,
      unknown,
  >
Parameters
- name: string
Returns ModelType
Inherited from Document.$model
- Defined in node_modules/mongoose/types/document.d.ts:92
$model<ModelType extends Model<any, {}, {}, {}, any, any, any>>(): ModelType
Returns the model with the given name on this document's associated connection.
Type Parameters
- ModelType extends Model<any, {}, {}, {}, any, any, any>
Returns ModelType
Inherited from Document.$model
- Defined in node_modules/mongoose/types/document.d.ts:93

$parent

$parent(): Document<ObjectId, any, any, Record<string, any>, {}> | undefined
If this document is a subdocument or populated document, returns the document's parent. Returns undefined otherwise.

Returns Document<ObjectId, any, any, Record<string, any>, {}> | undefined
Inherited from Document.$parent
- Defined in node_modules/mongoose/types/document.d.ts:238

$restoreModifiedPathsSnapshot

$restoreModifiedPathsSnapshot(snapshot: ModifiedPathsSnapshot): this
Restore this document's change tracking state to the given snapshot. Note that $restoreModifiedPathsSnapshot() does not modify the document's properties, just resets the change tracking state.
Parameters
- snapshot: ModifiedPathsSnapshot
Returns this
Inherited from Document.$restoreModifiedPathsSnapshot
- Defined in node_modules/mongoose/types/document.d.ts:106

$session

$session(session?: ClientSession | null): ClientSession | null
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
- Optionalsession: ClientSession | null
Returns ClientSession | null
Inherited from Document.$session
- Defined in node_modules/mongoose/types/document.d.ts:113

$set

$set(
    path: string | Record<string, any>,
    val: any,
    type: any,
    options?: DocumentSetOptions,
): this
Alias for set(), used internally to avoid conflicts
Parameters
- path: string | Record<string, any>
- val: any
- type: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.$set
- Defined in node_modules/mongoose/types/document.d.ts:116
$set(
    path: string | Record<string, any>,
    val: any,
    options?: DocumentSetOptions,
): this
Alias for set(), used internally to avoid conflicts
Parameters
- path: string | Record<string, any>
- val: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.$set
- Defined in node_modules/mongoose/types/document.d.ts:117
$set(value: string | Record<string, any>): this
Alias for set(), used internally to avoid conflicts
Parameters
- value: string | Record<string, any>
Returns this
Inherited from Document.$set
- Defined in node_modules/mongoose/types/document.d.ts:118

deleteOne

deleteOne(options?: QueryOptions<unknown>): any
Removes this document from the db.
Parameters
- Optionaloptions: QueryOptions<unknown>
Returns any
Inherited from Document.deleteOne
- Defined in node_modules/mongoose/types/document.d.ts:133

depopulate

depopulate<Paths = {}>(path?: string | string[]): MergeType<UserDocument, Paths>
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.
Type Parameters
- Paths = {}
Parameters
- Optionalpath: string | string[]
Returns MergeType<UserDocument, Paths>
Inherited from Document.depopulate
- Defined in node_modules/mongoose/types/document.d.ts:145

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[]
Inherited from Document.directModifiedPaths
- Defined in node_modules/mongoose/types/document.d.ts:152

equals

equals(doc: Document<string>): 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: Document<string>
Returns boolean
Inherited from Document.equals
- Defined in node_modules/mongoose/types/document.d.ts:161

get

get<T extends string | number | symbol>(path: T, type?: any, options?: any): any
Returns the value of a path.
Type Parameters
- T extends string | number | symbol
Parameters
- path: T
- Optionaltype: any
- Optionaloptions: any
Returns any
Inherited from Document.get
- Defined in node_modules/mongoose/types/document.d.ts:167
get(path: string, type?: any, options?: any): any
Returns the value of a path.
Parameters
- path: string
- Optionaltype: any
- Optionaloptions: any
Returns any
Inherited from Document.get
- Defined in node_modules/mongoose/types/document.d.ts:168

getChanges

getChanges(): UpdateQuery<UserDocument>
Returns the changes that happened to the document in the format that will be sent to MongoDB.

Returns UpdateQuery<UserDocument>
Inherited from Document.getChanges
- Defined in node_modules/mongoose/types/document.d.ts:174

increment

increment(): this
Signal that we desire an increment of this documents version.

Returns this
Inherited from Document.increment
- Defined in node_modules/mongoose/types/document.d.ts:177

init

init(obj: AnyObject, opts?: AnyObject): 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
- Optionalopts: AnyObject
Returns this
Inherited from Document.init
- Defined in node_modules/mongoose/types/document.d.ts:184

invalidate

invalidate<T extends string | number | symbol>(
    path: T,
    errorMsg: string | NativeError,
    value?: any,
    kind?: string,
): NativeError | null
Marks a path as invalid, causing validation to fail.
Type Parameters
- T extends string | number | symbol
Parameters
- path: T
- errorMsg: string | NativeError
- Optionalvalue: any
- Optionalkind: string
Returns NativeError | null
Inherited from Document.invalidate
- Defined in node_modules/mongoose/types/document.d.ts:187
invalidate(
    path: string,
    errorMsg: string | NativeError,
    value?: any,
    kind?: string,
): NativeError | null
Marks a path as invalid, causing validation to fail.
Parameters
- path: string
- errorMsg: string | NativeError
- Optionalvalue: any
- Optionalkind: string
Returns NativeError | null
Inherited from Document.invalidate
- Defined in node_modules/mongoose/types/document.d.ts:188

isDirectModified

isDirectModified<T extends string | number | symbol>(path: T | T[]): 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
Inherited from Document.isDirectModified
- Defined in node_modules/mongoose/types/document.d.ts:191
isDirectModified(path: string | string[]): boolean
Returns true if path was directly set and modified, else false.
Parameters
- path: string | string[]
Returns boolean
Inherited from Document.isDirectModified
- Defined in node_modules/mongoose/types/document.d.ts:192

isDirectSelected

isDirectSelected<T extends string | number | symbol>(path: T): 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
Inherited from Document.isDirectSelected
- Defined in node_modules/mongoose/types/document.d.ts:195
isDirectSelected(path: string): boolean
Checks if path was explicitly selected. If no projection, always returns true.
Parameters
- path: string
Returns boolean
Inherited from Document.isDirectSelected
- Defined in node_modules/mongoose/types/document.d.ts:196

isInit

isInit<T extends string | number | symbol>(path: T): 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
Inherited from Document.isInit
- Defined in node_modules/mongoose/types/document.d.ts:199
isInit(path: string): boolean
Checks if path is in the init state, that is, it was set by Document#init() and not modified since.
Parameters
- path: string
Returns boolean
Inherited from Document.isInit
- Defined in node_modules/mongoose/types/document.d.ts:200

isModified

isModified<T extends string | number | symbol>(
path?: T | T[],
options?: { ignoreAtomics?: boolean } | null,
): 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
- Optionalpath: T | T[]
- Optionaloptions: { ignoreAtomics?: boolean } | null
Returns boolean
Inherited from Document.isModified
- Defined in node_modules/mongoose/types/document.d.ts:206
isModified(
path?: string | string[],
options?: { ignoreAtomics?: boolean } | null,
): 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.
Parameters
- Optionalpath: string | string[]
- Optionaloptions: { ignoreAtomics?: boolean } | null
Returns boolean
Inherited from Document.isModified
- Defined in node_modules/mongoose/types/document.d.ts:207

isSelected

isSelected<T extends string | number | symbol>(path: T): 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
Inherited from Document.isSelected
- Defined in node_modules/mongoose/types/document.d.ts:213
isSelected(path: string): boolean
Checks if path was selected in the source query which initialized this document.
Parameters
- path: string
Returns boolean
Inherited from Document.isSelected
- Defined in node_modules/mongoose/types/document.d.ts:214

markModified

markModified<T extends string | number | symbol>(path: T, scope?: any): void
Marks the path as having pending changes to write to the db.
Type Parameters
- T extends string | number | symbol
Parameters
- path: T
- Optionalscope: any
Returns void
Inherited from Document.markModified
- Defined in node_modules/mongoose/types/document.d.ts:217
markModified(path: string, scope?: any): void
Marks the path as having pending changes to write to the db.
Parameters
- path: string
- Optionalscope: any
Returns void
Inherited from Document.markModified
- Defined in node_modules/mongoose/types/document.d.ts:218

model

model<
    ModelType extends
        Model<
            unknown,
            {},
            {},
            {},
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
            any,
            unknown,
        >,
>(
    name: string,
): ModelType
Returns the model with the given name on this document's associated connection.
Type Parameters
- ModelType extends Model<
      unknown,
      {},
      {},
      {},
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
      any,
      unknown,
  >
Parameters
- name: string
Returns ModelType
Inherited from Document.model
- Defined in node_modules/mongoose/types/document.d.ts:221
model<ModelType extends Model<any, {}, {}, {}, any, any, any>>(): ModelType
Returns the model with the given name on this document's associated connection.
Type Parameters
- ModelType extends Model<any, {}, {}, {}, any, any, any>
Returns ModelType
Inherited from Document.model
- Defined in node_modules/mongoose/types/document.d.ts:222

modifiedPaths

modifiedPaths(options?: { includeChildren?: boolean }): string[]
Returns the list of paths that have been modified.
Parameters
- Optionaloptions: { includeChildren?: boolean }
Returns string[]
Inherited from Document.modifiedPaths
- Defined in node_modules/mongoose/types/document.d.ts:225

overwrite

overwrite(obj: AnyObject): 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
Inherited from Document.overwrite
- Defined in node_modules/mongoose/types/document.d.ts:232

populate

populate<Paths = {}>(
path: string | PopulateOptions | (string | PopulateOptions)[],
): Promise<MergeType<UserDocument, Paths>>
Populates document references.
Type Parameters
- Paths = {}
Parameters
- path: string | PopulateOptions | (string | PopulateOptions)[]
Returns Promise<MergeType<UserDocument, Paths>>
Inherited from Document.populate
- Defined in node_modules/mongoose/types/document.d.ts:241
populate<Paths = {}>(
    path: string,
    select?: string | AnyObject,
    model?: Model<any, {}, {}, {}, any, any, any>,
    match?: AnyObject,
    options?: PopulateOptions,
): Promise<MergeType<UserDocument, Paths>>
Populates document references.
Type Parameters
- Paths = {}
Parameters
- path: string
- Optionalselect: string | AnyObject
- Optionalmodel: Model<any, {}, {}, {}, any, any, any>
- Optionalmatch: AnyObject
- Optionaloptions: PopulateOptions
Returns Promise<MergeType<UserDocument, Paths>>
Inherited from Document.populate
- Defined in node_modules/mongoose/types/document.d.ts:242

populated

populated(path: string): any
Gets _id(s) used during population of the given path. If the path was not populated, returns undefined.
Parameters
- path: string
Returns any
Inherited from Document.populated
- Defined in node_modules/mongoose/types/document.d.ts:245

replaceOne

replaceOne(
replacement?: AnyObject,
options?: QueryOptions<unknown> | null,
): Query<any, UserDocument>
Sends a replaceOne command with this document _id as the query selector.
Parameters
- Optionalreplacement: AnyObject
- Optionaloptions: QueryOptions<unknown> | null
Returns Query<any, UserDocument>
Inherited from Document.replaceOne
- Defined in node_modules/mongoose/types/document.d.ts:248

save

save(options?: SaveOptions): Promise<UserDocument>
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
- Optionaloptions: SaveOptions
Returns Promise<UserDocument>
Inherited from Document.save
- Defined in node_modules/mongoose/types/document.d.ts:251

set

set<T extends string | number | symbol>(
    path: T,
    val: any,
    type: any,
    options?: DocumentSetOptions,
): this
Sets the value of a path, or many paths.
Type Parameters
- T extends string | number | symbol
Parameters
- path: T
- val: any
- type: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:257
set(
    path: string | Record<string, any>,
    val: any,
    type: any,
    options?: DocumentSetOptions,
): this
Sets the value of a path, or many paths.
Parameters
- path: string | Record<string, any>
- val: any
- type: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:258
set(
    path: string | Record<string, any>,
    val: any,
    options?: DocumentSetOptions,
): this
Sets the value of a path, or many paths.
Parameters
- path: string | Record<string, any>
- val: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:259
set(value: string | Record<string, any>): this
Sets the value of a path, or many paths.
Parameters
- value: string | Record<string, any>
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:260

toBSON

toBSON(): any
Returns any
Inherited from Document.toBSON
- Defined in node_modules/mongoose/types/document.d.ts:262

toJSON

toJSON<
    O extends
        ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
>(
    options: O,
): ApplyVersionKey<
    ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
        __v?: U;
    }
        ? { __v?: U } & ApplyFlattenTransforms<
            ApplyVirtuals<any, Record<string, any>, O>,
            O,
        >
        : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
            __v: number;
        },
    O,
    {},
>
The return value of this method is used in calls to JSON.stringify(doc).
Type Parameters
- O extends ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Parameters
- options: O
Returns ApplyVersionKey<
    ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
        __v?: U;
    }
        ? { __v?: U } & ApplyFlattenTransforms<
            ApplyVirtuals<any, Record<string, any>, O>,
            O,
        >
        : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
            __v: number;
        },
    O,
    {},
>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:265
toJSON(
    options?: ToObjectOptions<
        unknown,
        Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
            _id: ObjectId;
        } & { __v: number } & { id: string },
    >,
): any
The return value of this method is used in calls to JSON.stringify(doc).
Parameters
- Optionaloptions: ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Returns any
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:266
toJSON<T>(
    options?: ToObjectOptions<
        unknown,
        Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
            _id: ObjectId;
        } & { __v: number } & { id: string },
    >,
): Require_id<T> & { __v: number }
The return value of this method is used in calls to JSON.stringify(doc).
Type Parameters
- T
Parameters
- Optionaloptions: ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Returns Require_id<T> & { __v: number }
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:267

toObject

toObject<
    O extends
        ToObjectOptions<
            unknown,
            Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
                _id: ObjectId;
            } & { __v: number } & { id: string },
        >,
>(
    options: O,
): ApplyVersionKey<
    ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
        __v?: U;
    }
        ? { __v?: U } & ApplyFlattenTransforms<
            ApplyVirtuals<any, Record<string, any>, O>,
            O,
        >
        : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
            __v: number;
        },
    O,
    {},
>
Converts this document into a plain-old JavaScript object (POJO).
Type Parameters
- O extends ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Parameters
- options: O
Returns ApplyVersionKey<
    ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> extends {
        __v?: U;
    }
        ? { __v?: U } & ApplyFlattenTransforms<
            ApplyVirtuals<any, Record<string, any>, O>,
            O,
        >
        : ApplyFlattenTransforms<ApplyVirtuals<any, Record<string, any>, O>, O> & {
            __v: number;
        },
    O,
    {},
>
Inherited from Document.toObject
- Defined in node_modules/mongoose/types/document.d.ts:270
toObject(
    options?: ToObjectOptions<
        unknown,
        Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
            _id: ObjectId;
        } & { __v: number } & { id: string },
    >,
): any
Converts this document into a plain-old JavaScript object (POJO).
Parameters
- Optionaloptions: ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Returns any
Inherited from Document.toObject
- Defined in node_modules/mongoose/types/document.d.ts:271
toObject<T>(
    options?: ToObjectOptions<
        unknown,
        Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
            _id: ObjectId;
        } & { __v: number } & { id: string },
    >,
): Require_id<T> & { __v: number }
Converts this document into a plain-old JavaScript object (POJO).
Type Parameters
- T
Parameters
- Optionaloptions: ToObjectOptions<
      unknown,
      Document<unknown, {}, unknown, {}, DefaultSchemaOptions> & {
          _id: ObjectId;
      } & { __v: number } & { id: string },
  >
Returns Require_id<T> & { __v: number }
Inherited from Document.toObject
- Defined in node_modules/mongoose/types/document.d.ts:272

unmarkModified

unmarkModified<T extends string | number | symbol>(path: T): void
Clears the modified state on the specified path.
Type Parameters
- T extends string | number | symbol
Parameters
- path: T
Returns void
Inherited from Document.unmarkModified
- Defined in node_modules/mongoose/types/document.d.ts:275
unmarkModified(path: string): void
Clears the modified state on the specified path.
Parameters
- path: string
Returns void
Inherited from Document.unmarkModified
- Defined in node_modules/mongoose/types/document.d.ts:276

updateOne

updateOne(
update?: UpdateWithAggregationPipeline | UpdateQuery<UserDocument>,
options?: QueryOptions<unknown> | null,
): Query<any, UserDocument>
Sends an updateOne command with this document _id as the query selector.
Parameters
- Optionalupdate: UpdateWithAggregationPipeline | UpdateQuery<UserDocument>
- Optionaloptions: QueryOptions<unknown> | null
Returns Query<any, UserDocument>
Inherited from Document.updateOne
- Defined in node_modules/mongoose/types/document.d.ts:279

validate

validate<T extends string | number | symbol>(
pathsToValidate?: T | T[],
options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
): Promise<void>
Executes registered validation rules for this document.
Type Parameters
- T extends string | number | symbol
Parameters
- OptionalpathsToValidate: T | T[]
- Optionaloptions: Omit<ValidateOptions, "pathsToSkip"> & AnyObject
Returns Promise<void>
Inherited from Document.validate
- Defined in node_modules/mongoose/types/document.d.ts:282
validate(
pathsToValidate?: PathsToValidate,
options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
): Promise<void>
Executes registered validation rules for this document.
Parameters
- OptionalpathsToValidate: PathsToValidate
- Optionaloptions: Omit<ValidateOptions, "pathsToSkip"> & AnyObject
Returns Promise<void>
Inherited from Document.validate
- Defined in node_modules/mongoose/types/document.d.ts:283
validate(options: ValidateOptions): Promise<void>
Executes registered validation rules for this document.
Parameters
- options: ValidateOptions
Returns Promise<void>
Inherited from Document.validate
- Defined in node_modules/mongoose/types/document.d.ts:284

validateSync

validateSync(
options: ValidateOptions & { [k: string]: any },
): ValidationError | null
Executes registered validation rules (skipping asynchronous validators) for this document.
Parameters
- options: ValidateOptions & { [k: string]: any }
Returns ValidationError | null
Inherited from Document.validateSync
- Defined in node_modules/mongoose/types/document.d.ts:287
validateSync<T extends string | number | symbol>(
pathsToValidate?: T | T[],
options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
): ValidationError | null
Executes registered validation rules (skipping asynchronous validators) for this document.
Type Parameters
- T extends string | number | symbol
Parameters
- OptionalpathsToValidate: T | T[]
- Optionaloptions: Omit<ValidateOptions, "pathsToSkip"> & AnyObject
Returns ValidationError | null
Inherited from Document.validateSync
- Defined in node_modules/mongoose/types/document.d.ts:288
validateSync(
pathsToValidate?: PathsToValidate,
options?: Omit<ValidateOptions, "pathsToSkip"> & AnyObject,
): ValidationError | null
Executes registered validation rules (skipping asynchronous validators) for this document.
Parameters
- OptionalpathsToValidate: PathsToValidate
- Optionaloptions: Omit<ValidateOptions, "pathsToSkip"> & AnyObject
Returns ValidationError | null
Inherited from Document.validateSync
- Defined in node_modules/mongoose/types/document.d.ts:289

Interface UserDocument

Hierarchy

Index

Properties

Methods

Properties

Readonly_id

$locals

$op

$where

OptionalbaseModelName

collection

ReadonlycreatedAt

db

Optionalerrors

isNew

Readonlypassword

Readonlyrole

schema

ReadonlyupdatedAt

Readonlyusername

Methods

$assertPopulated

Type Parameters

Parameters

Returns Omit<UserDocument, keyof Paths> & Paths

$clearModifiedPaths

Returns this

$clone

Returns this

$createModifiedPathsSnapshot

Returns ModifiedPathsSnapshot

$getAllSubdocs

Returns Document<ObjectId, any, any, Record<string, any>, {}>[]

$getPopulatedDocs

Returns Document<ObjectId, any, any, Record<string, any>, {}>[]

$ignore

Parameters

Returns void

$inc

Parameters

Returns this

$isDefault

Parameters

Returns boolean

$isDeleted

Parameters

Returns boolean

$isEmpty

Parameters

Returns boolean

$isValid

Parameters

Returns boolean

$markValid

Parameters

Returns void

$model

Type Parameters

Parameters

Returns ModelType

Type Parameters

Returns ModelType

$parent

Returns Document<ObjectId, any, any, Record<string, any>, {}> | undefined

$restoreModifiedPathsSnapshot

Parameters

Returns this

$session

Parameters

Returns ClientSession | null

$set

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

deleteOne

Parameters

`Readonly`_id

`Optional`baseModelName

`Readonly`createdAt

`Optional`errors

`Readonly`password

`Readonly`role

`Readonly`updatedAt

`Readonly`username