Property "password" does not exists on type Document

Question

I am getting this error Property "password" does not exists on type Document. So can anyone tell if there is something wrong with my code ?

const userSchema = new mongoose.Schema({
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
  name: { type: String, required: true }
});

userSchema.pre("save", function save(next) {
  const user = this;
  if (!user.isModified("password")) {
    return next();
  }
  bcrypt.genSalt(10, (err, salt) => {
    if (err) {
      return next(err);
    }
    bcrypt.hash(user.password, salt, (err: mongoose.Error, hash) => {
      if (err) {
        return next(err);
      }
      user.password = hash;
      next();
    });
  });
});

See [Using mongoose pre-save hook with typescript](https://github.com/Automattic/mongoose/issues/5046#issuecomment-412114160) — Shivam Jha, Jan 23 '21 at 11:24

score 20 · Accepted Answer · answered Dec 06 '18 at 05:20

20

You need to add type here with pre-save hook as per the mongoose docs, pre hook is defined as,

/**
 * Defines a pre hook for the document.
 */
pre<T extends Document = Document>(
  method: "init" | "validate" | "save" | "remove",
  fn: HookSyncCallback<T>,
  errorCb?: HookErrorCallback
): this;

and if you have an interface like below then,

export interface IUser {
  email: string;
  password: string;
  name: string;
}

Add type with pre-save hook,

userSchema.pre<IUser>("save", function save(next) { ... }

answered Dec 06 '18 at 05:20

Shivam Pandey

3,756
2
19
26

1

Also can you please comment the link where this is mentioned . Couldnt find it – Barometer Dec 06 '18 at 06:09
2

from the mongoose repo, https://github.com/Automattic/mongoose/issues/5046#issuecomment-412114160 – Shivam Pandey Dec 06 '18 at 06:17
@Barometer Glad, it helped! Please consider accepting my answer. – Shivam Pandey Dec 06 '18 at 06:50
1

I changed `export interface IUser` to `export interface IUser extends Document {` after `import { Document } from 'mongoose';` which removed the need for defining the `pre(` above. – Diesel Feb 03 '19 at 01:21

score 7 · Answer 2 · answered Sep 21 '20 at 16:48

I dont know if this will help as the question is old now, however I tried this

import mongoose, { Document } from 'mongoose';

const User = mongoose.model<IUser & Document>("users", UserSchema);

type IUser = {
    username: string
    password: string
}

mongoose.model needs a Document type, and you want to extend that document, therefore Unify the two types

score 5 · Answer 3 · answered Mar 21 '21 at 21:36

you can also pass the interface type to the schema itself.

import { model, Schema, Document } from 'mongoose';

const userSchema = new mongoose.Schema<IUser>({
  email: { type: String, required: true, unique: true },
  password: { type: String, required: true },
  name: { type: String, required: true }
});

interface IUser extends Document{
  email: string;
  password: string;
  name: string;
}

score -1 · Answer 4 · edited Apr 20 '21 at 10:11

-1

Declare the .pre function shortly after schema construction, after the interface with the fields defined, is declared.

edited Apr 20 '21 at 10:11

sr9yar

4,850
5
53
59

answered Aug 17 '20 at 03:05

Guilherme Humberto

1

Property "password" does not exists on type Document

4 Answers4