Typescript error when working with mongoose ( running inside kubernetes cluster and skaffold )

Question

The code is,

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

console.log(userSchema);

userSchema.statics.build = (user: UserAttrs) => {
  return new User(user);
};

userSchema.pre("save", async function (next) {
  if (this.isModified("password")) {
    const hashed = await Password.toHash(this.get("password"));
    this.set("password", hashed);
  }
  next();
});

Now, the error I'm running into is,

[auth] > [email protected] start /app
[auth] > ts-node-dev src/index.ts
[auth]
[auth] [INFO] 12:46:59 ts-node-dev ver. 1.0.0 (using ts-node ver. 9.0.0, typescript ver. 3.9.7)
[auth] Compilation error in /app/src/models/user.ts
[auth] [ERROR] 12:47:04 ⨯ Unable to compile TypeScript:
[auth] src/models/user.ts(37,12): error TS2551: Property 'statics' does not exist on type 'Schema'. Did you mean 'static'?
[auth] src/models/user.ts(46,3): error TS2554: Expected 1 arguments, but got 0.

The statics property does exist in the schema object and it does show when I console.log(userSchema). I think it has something to do with kubernetes and skaffold. Any idea how to fix this problem ??

Answer 1

I think this could help

First you have to create 3 interfaces.

interface UserAttrs {
  email: string;
  password: string;
}

interface UserModel extends mongoose.Model<UserDoc> {
  build(attrs: UserAttrs): UserDoc;
}

interface UserDoc extends mongoose.Document {
  email: string;
  password: string; 
}

Then in your schema's middleware you have to declare the type of the variables that you're using

userSchema.pre("save", async function (this: UserDoc, next: any) {
  if (this.isModified("password")) {
    const hashed = await Password.toHash(this.get("password"));
    this.set("password", hashed);
  }
  next();
});

const User = mongoose.model<UserDoc, UserModel>('User', userSchema);

Related issue that I found