Define Mongoose models using TypeScript classes.
;;; // UserModel is a regular Mongoose Model with correct types;
A common problem when using Mongoose with TypeScript is that you have to define both the Mongoose model and the TypeScript interface. If the model changes, you also have to keep the TypeScript interface file in sync or the TypeScript interface would not represent the real data structure of the model.
Typegoose aims to solve this problem by defining only a TypeScript interface (class) which need to be enhanced with special Typegoose decorators.
Under the hood it uses the Reflect & reflect-metadata API to retrieve the types of the properties, so redundancy can be significantly reduced.
You can just:
- TypeScript 3.7+
- Node 8.10+
- mongoose ^5.9.2
experimentalDecoratorsmust be enabled in
npm i -s @typegoose/typegoose
You also need to install
mongoose, since version 5 it is listed as a peer-dependency
npm i -s mongoose
npm run test
Run our tests after running
npm i -D
Major.Minor.Fix (or how npm expresses it
(This Project should comply with Semver)
Join Our Discord Server
To ask questions or just talk with us join our Discord Server
Migrate to 6.0.0
- Please dont add comments with
+1or something like that, use the Reactions
npm run docgenerates all documentation for all files that can be used as modules (is used for github-pages)
npm run doc:allgenerates documentation even for internal modules