Typescript and Mongoose Model

Question

I 'm trying to bind my Model with a mongoose schema using Typescript. I have my IUser interface:

export interface IUser{

   _id: string;

   _email: string;
}

My User class:

export class User implements IUser{
  _id: string;
  _email: string;
}

My RepositoryBase:

export class RepositoryBase<T extends mongoose.Document> {

 private _model: mongoose.Model<mongoose.Document>;

  constructor(schemaModel: mongoose.Model<mongoose.Document>) {
     this._model = schemaModel;
  }

 create(item: T): mongoose.Promise<mongoose.model<T>> {
    return this._model.create(item);
 }
}

And finally my UserRepository which extends RepositoryBase and implements an IUserRepository (actually empty):

export class UserRepository  extends RepositoryBase<IUser> implements     IUserRepository{

  constructor(){
    super(mongoose.model<IUser>("User", 
        new mongoose.Schema({
            _id: String,
            _email: String,
        }))
    )
  }

}

Thr problem is that typescript compiler keeps saying : Type 'IUser' does not satisfy the constraint 'Document'

And if I do:

export interface IUser extends mongoose.Document

That problem is solved but the compiler says: Property 'increment' is missing in type 'User'

Really, i don't want my IUser to extend mongoose.Document, because neither IUser or User should know about how Repository work nor it's implementation.

See if this helps: github.com/Appsilon/styleguide/wiki/mongoose-typescript-models — Harry Joy
– Harry Joy, Commented Sep 12, 2016 at 17:23
Thanks Harry, that was very useful. But the "export mongoose.model<IUserModel>("User", userSchema)" i should do it in my User class. But then i loose all my methods, isn't it? — JVilla
– JVilla, Commented Sep 12, 2016 at 17:46

Mateja Petrovic · Accepted Answer · 2019-08-25 22:49:33Z

11

I solved the issue by referencing this blog post.

The trick was to extends the Document interface from mongoose like so:

import { Model, Document } from 'mongoose';

interface User {
  id: string;
  email: string;
}

interface UserModel extends User, Document {}

Model<UserModel> // doesn't throw an error anymore

answered Aug 25, 2019 at 22:49

Mateja Petrovic

4,4754 gold badges31 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Wasit Shafi Jan 22 at 21:41

FYI: although extending the Document will make the code work properly but keep in mind that doing so will cause major performance issues, especially related to type inference, also that approach is not recommended officially Refer: mongoosejs.com/docs/6.x/docs/… . I also had used the same approach earlier (due to Zod schema validation & some custom logic) but now I have switched to automatic type inference which is officially recommended by Mongoose Refer: mongoosejs.com/docs/typescript/…

Collectives™ on Stack Overflow

Typescript and Mongoose Model

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related