Interface IUser

User interface

interface IUser {
    _id: unknown;
    $locals: Record<string, unknown>;
    $op:
        | null
        | "remove"
        | "validate"
        | "save";
    $where: Record<string, unknown>;
    baseModelName?: string;
    collection: Collection<Document>;
    db: Connection;
    email: string;
    errors?: ValidationError;
    id?: any;
    isNew: boolean;
    password: string;
    schema: Schema<any, Model<any, any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}, Document<unknown, {}, FlatRecord<{}>> & FlatRecord<{}> & Required<{
        _id: unknown;
    }> & {
        __v: number;
    }>;
    $assertPopulated<Paths>(path: string | string[], values?: Partial<Paths>): Omit<IUser, keyof Paths> & Paths;
    $clearModifiedPaths(): this;
    $clone(): this;
    $createModifiedPathsSnapshot(): ModifiedPathsSnapshot;
    $getAllSubdocs(): Document<unknown, any, any>[];
    $getPopulatedDocs(): Document<unknown, any, 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>(name: string): ModelType;
    $model<ModelType>(): ModelType;
    $parent(): undefined | Document<unknown, any, any>;
    $restoreModifiedPathsSnapshot(snapshot: ModifiedPathsSnapshot): this;
    $session(session?: null | ClientSession): null | ClientSession;
    $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<IUser, Paths>;
    directModifiedPaths(): string[];
    equals(doc: Document<unknown, any, any>): boolean;
    get<T>(path: T, type?: any, options?: any): any;
    get(path: string, type?: any, options?: any): any;
    getChanges(): UpdateQuery<IUser>;
    increment(): this;
    init(obj: AnyObject, opts?: AnyObject): this;
    invalidate<T>(path: T, errorMsg: string | NativeError, value?: any, kind?: string): null | NativeError;
    invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): null | NativeError;
    isDirectModified<T>(path: T | T[]): boolean;
    isDirectModified(path: string | string[]): boolean;
    isDirectSelected<T>(path: T): boolean;
    isDirectSelected(path: string): boolean;
    isInit<T>(path: T): boolean;
    isInit(path: string): boolean;
    isModified<T>(path?: T | T[], options?: null | {
        ignoreAtomics?: boolean;
    }): boolean;
    isModified(path?: string | string[], options?: null | {
        ignoreAtomics?: boolean;
    }): boolean;
    isSelected<T>(path: T): boolean;
    isSelected(path: string): boolean;
    markModified<T>(path: T, scope?: any): void;
    markModified(path: string, scope?: any): void;
    matchPassword(enteredPassword: string): Promise<boolean>;
    model<ModelType>(name: string): ModelType;
    model<ModelType>(): ModelType;
    modifiedPaths(options?: {
        includeChildren?: boolean;
    }): string[];
    overwrite(obj: AnyObject): this;
    populate<Paths>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<MergeType<IUser, Paths>>;
    populate<Paths>(path: string, select?: string | AnyObject, model?: Model<any, {}, {}, {}, any, any>, match?: AnyObject, options?: PopulateOptions): Promise<MergeType<IUser, Paths>>;
    populated(path: string): any;
    replaceOne(replacement?: AnyObject, options?: null | QueryOptions<unknown>): Query<any, IUser, {}, unknown, "find", Record<string, never>>;
    save(options?: SaveOptions): Promise<IUser>;
    set<T>(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;
    toJSON(options?: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps?: true;
        flattenObjectIds?: false;
    }): FlattenMaps<any>;
    toJSON(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenObjectIds: false;
    }): FlattenMaps<any>;
    toJSON(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenObjectIds: true;
    }): {};
    toJSON(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps: false;
    }): any;
    toJSON(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps: false;
        flattenObjectIds: true;
    }): any;
    toJSON<T>(options?: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps?: true;
        flattenObjectIds?: false;
    }): FlattenMaps<T>;
    toJSON<T>(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenObjectIds: false;
    }): FlattenMaps<T>;
    toJSON<T>(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenObjectIds: true;
    }): ObjectIdToString<FlattenMaps<T>>;
    toJSON<T>(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps: false;
    }): T;
    toJSON<T>(options: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }> & {
        flattenMaps: false;
        flattenObjectIds: true;
    }): ObjectIdToString<T>;
    toObject(options?: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }>): any;
    toObject<T>(options?: ToObjectOptions<Document<unknown, {}, unknown> & {
        _id: ObjectId;
    } & {
        __v: number;
    }>): Require_id<T>;
    unmarkModified<T>(path: T): void;
    unmarkModified(path: string): void;
    updateOne(update?: UpdateWithAggregationPipeline | UpdateQuery<IUser>, options?: null | QueryOptions<unknown>): Query<any, IUser, {}, unknown, "find", Record<string, never>>;
    validate<T>(pathsToValidate?: T | T[], options?: AnyObject): Promise<void>;
    validate(pathsToValidate?: PathsToValidate, options?: AnyObject): Promise<void>;
    validate(options: {
        pathsToSkip?: pathsToSkip;
    }): Promise<void>;
    validateSync(options: {
        pathsToSkip?: pathsToSkip;
        [k: string]: any;
    }): null | ValidationError;
    validateSync<T>(pathsToValidate?: T | T[], options?: AnyObject): null | ValidationError;
    validateSync(pathsToValidate?: PathsToValidate, options?: AnyObject): null | ValidationError;
}

Hierarchy

Document
- IUser

Properties

_id

_id: unknown

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:
    | null
    | "remove"
    | "validate"
    | "save"

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<Document>

Collection the model uses.

db

db: Connection

Connection the model uses.

email

email: string

The user email.

`Optional`errors

errors?: ValidationError

Returns the current validation errors.

`Optional`id

id?: any

The string version of this documents _id.

isNew

isNew: boolean

Boolean flag specifying if the document is new.

password

password: string

The user password.

schema

schema: Schema<any, Model<any, any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}, Document<unknown, {}, FlatRecord<{}>> & FlatRecord<{}> & Required<{
_id: unknown;
}> & {
__v: number;
}>

The document's schema.

Methods

$assertPopulated

$assertPopulated<Paths>(path, values?): Omit<IUser, 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<IUser, keyof Paths> & Paths
Inherited from Document.$assertPopulated
- Defined in node_modules/mongoose/types/document.d.ts:28

$clearModifiedPaths

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

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

$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:34

$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:40

$getAllSubdocs

$getAllSubdocs(): Document<unknown, any, any>[]
Returns Document<unknown, any, any>[]
Inherited from Document.$getAllSubdocs
- Defined in node_modules/mongoose/types/document.d.ts:43

$getPopulatedDocs

$getPopulatedDocs(): Document<unknown, any, any>[]
Returns an array of all populated documents associated with the query

Returns Document<unknown, any, any>[]
Inherited from Document.$getPopulatedDocs
- Defined in node_modules/mongoose/types/document.d.ts:55

$ignore

$ignore(path): 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:46

$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[]
- Optionalval: number
Returns this
Inherited from Document.$inc
- Defined in node_modules/mongoose/types/document.d.ts:62

$isDefault

$isDefault(path): boolean
Checks if a path is set to its default.
Parameters
- path: string
Returns boolean
Inherited from Document.$isDefault
- Defined in node_modules/mongoose/types/document.d.ts:49

$isDeleted

$isDeleted(val?): 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:52

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

$isValid

$isValid(path): 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:72

$markValid

$markValid(path): 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:82

$model

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

$parent

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

Returns undefined | Document<unknown, any, any>
Inherited from Document.$parent
- Defined in node_modules/mongoose/types/document.d.ts:234

$restoreModifiedPathsSnapshot

$restoreModifiedPathsSnapshot(snapshot): 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:99

$session

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

$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
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.$set
- Defined in node_modules/mongoose/types/document.d.ts:109
$set(path, val, options?): this
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:110
$set(value): this
Parameters
- value: string | Record<string, any>
Returns this
Inherited from Document.$set
- Defined in node_modules/mongoose/types/document.d.ts:111

deleteOne

deleteOne(options?): 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:126

depopulate

depopulate<Paths>(path?): MergeType<IUser, 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<IUser, Paths>
Inherited from Document.depopulate
- Defined in node_modules/mongoose/types/document.d.ts:138

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:145

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: Document<unknown, any, any>
Returns boolean
Inherited from Document.equals
- Defined in node_modules/mongoose/types/document.d.ts:154

get

get<T>(path, type?, options?): 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:160
get(path, type?, options?): any
Parameters
- path: string
- Optionaltype: any
- Optionaloptions: any
Returns any
Inherited from Document.get
- Defined in node_modules/mongoose/types/document.d.ts:161

getChanges

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

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

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:173

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
- Optionalopts: AnyObject
Returns this
Inherited from Document.init
- Defined in node_modules/mongoose/types/document.d.ts:180

invalidate

invalidate<T>(path, errorMsg, value?, kind?): null | NativeError
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 null | NativeError
Inherited from Document.invalidate
- Defined in node_modules/mongoose/types/document.d.ts:183
invalidate(path, errorMsg, value?, kind?): null | NativeError
Parameters
- path: string
- errorMsg: string | NativeError
- Optionalvalue: any
- Optionalkind: string
Returns null | NativeError
Inherited from Document.invalidate
- Defined in node_modules/mongoose/types/document.d.ts:184

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
Inherited from Document.isDirectModified
- Defined in node_modules/mongoose/types/document.d.ts:187
isDirectModified(path): boolean
Parameters
- path: string | string[]
Returns boolean
Inherited from Document.isDirectModified
- Defined in node_modules/mongoose/types/document.d.ts:188

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
Inherited from Document.isDirectSelected
- Defined in node_modules/mongoose/types/document.d.ts:191
isDirectSelected(path): boolean
Parameters
- path: string
Returns boolean
Inherited from Document.isDirectSelected
- Defined in node_modules/mongoose/types/document.d.ts:192

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
Inherited from Document.isInit
- Defined in node_modules/mongoose/types/document.d.ts:195
isInit(path): boolean
Parameters
- path: string
Returns boolean
Inherited from Document.isInit
- Defined in node_modules/mongoose/types/document.d.ts:196

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

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
Inherited from Document.isSelected
- Defined in node_modules/mongoose/types/document.d.ts:209
isSelected(path): boolean
Parameters
- path: string
Returns boolean
Inherited from Document.isSelected
- Defined in node_modules/mongoose/types/document.d.ts:210

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
- Optionalscope: any
Returns void
Inherited from Document.markModified
- Defined in node_modules/mongoose/types/document.d.ts:213
markModified(path, scope?): void
Parameters
- path: string
- Optionalscope: any
Returns void
Inherited from Document.markModified
- Defined in node_modules/mongoose/types/document.d.ts:214

matchPassword

matchPassword(enteredPassword): Promise<boolean>
Match the entered password with the user password.
Parameters
- enteredPassword: string
  The entered password.
Returns Promise<boolean>
A promise that resolves to a boolean indicating if the passwords match.
- Defined in src/core/models/User.ts:24

model

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

modifiedPaths

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

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
Inherited from Document.overwrite
- Defined in node_modules/mongoose/types/document.d.ts:228

populate

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

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
Inherited from Document.populated
- Defined in node_modules/mongoose/types/document.d.ts:241

replaceOne

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

save

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

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: any
- type: any
- Optionaloptions: DocumentSetOptions
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:253
set(path, val, type, options?): this
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:254
set(path, val, options?): this
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:255
set(value): this
Parameters
- value: string | Record<string, any>
Returns this
Inherited from Document.set
- Defined in node_modules/mongoose/types/document.d.ts:256

toJSON

toJSON(options?): FlattenMaps<any>
The return value of this method is used in calls to JSON.stringify(doc).
Parameters
- Optionaloptions: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps?: true;
      flattenObjectIds?: false;
  }
Returns FlattenMaps<any>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:259
toJSON(options): FlattenMaps<any>
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenObjectIds: false;
  }
Returns FlattenMaps<any>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:260
toJSON(options): {}
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenObjectIds: true;
  }
Returns {}
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:261
toJSON(options): any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps: false;
  }
Returns any
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:262
toJSON(options): any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps: false;
      flattenObjectIds: true;
  }
Returns any
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:263
toJSON<T>(options?): FlattenMaps<T>
Type Parameters
- T = any
Parameters
- Optionaloptions: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps?: true;
      flattenObjectIds?: false;
  }
Returns FlattenMaps<T>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:265
toJSON<T>(options): FlattenMaps<T>
Type Parameters
- T = any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenObjectIds: false;
  }
Returns FlattenMaps<T>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:266
toJSON<T>(options): ObjectIdToString<FlattenMaps<T>>
Type Parameters
- T = any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenObjectIds: true;
  }
Returns ObjectIdToString<FlattenMaps<T>>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:267
toJSON<T>(options): T
Type Parameters
- T = any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps: false;
  }
Returns T
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:268
toJSON<T>(options): ObjectIdToString<T>
Type Parameters
- T = any
Parameters
- options: ToObjectOptions<Document<unknown, {}, unknown> & {
      _id: ObjectId;
  } & {
      __v: number;
  }> & {
      flattenMaps: false;
      flattenObjectIds: true;
  }
Returns ObjectIdToString<T>
Inherited from Document.toJSON
- Defined in node_modules/mongoose/types/document.d.ts:269

toObject

toObject(options?): any
Converts this document into a plain-old JavaScript object (POJO).
Parameters
- Optionaloptions: ToObjectOptions<Document<unknown, {}, unknown> & {
  _id: ObjectId;
  } & {
  __v: number;
  }>
Returns any
Inherited from Document.toObject
- Defined in node_modules/mongoose/types/document.d.ts:272
toObject<T>(options?): Require_id<T>
Type Parameters
- T
Parameters
- Optionaloptions: ToObjectOptions<Document<unknown, {}, unknown> & {
  _id: ObjectId;
  } & {
  __v: number;
  }>
Returns Require_id<T>
Inherited from Document.toObject
- Defined in node_modules/mongoose/types/document.d.ts:273

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
Inherited from Document.unmarkModified
- Defined in node_modules/mongoose/types/document.d.ts:276
unmarkModified(path): void
Parameters
- path: string
Returns void
Inherited from Document.unmarkModified
- Defined in node_modules/mongoose/types/document.d.ts:277

updateOne

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

validate

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

validateSync

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

Interface IUser

Hierarchy

Index

Properties

Methods

Properties

_id

$locals

$op

$where

OptionalbaseModelName

collection

db

email

Optionalerrors

Optionalid

isNew

password

schema

Methods

$assertPopulated

Type Parameters

Parameters

Returns Omit<IUser, keyof Paths> & Paths

$clearModifiedPaths

Returns this

$clone

Returns this

$createModifiedPathsSnapshot

Returns ModifiedPathsSnapshot

$getAllSubdocs

Returns Document<unknown, any, any>[]

$getPopulatedDocs

Returns Document<unknown, any, 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 undefined | Document<unknown, any, any>

$restoreModifiedPathsSnapshot

Parameters

Returns this

$session

Parameters

Returns null | ClientSession

$set

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

deleteOne

Parameters

Returns any

depopulate

`Optional`baseModelName

`Optional`errors

`Optional`id