@typegoose/typegoose

Typegoose

_{(These badges are from typegoose:master)}

Define Mongoose models using TypeScript classes.

Basic usage

import { prop, getModelForClass } from '@typegoose/typegoose';
import * as mongoose from 'mongoose';

class User {
  @prop()
  public name?: string;
}

const UserModel = getModelForClass(User); // UserModel is a regular Mongoose Model with correct types

(async () => {
  await mongoose.connect('mongodb://localhost:27017/', { useNewUrlParser: true, useUnifiedTopology: true, dbName: "test" });

  const { _id: id } = await UserModel.create({ name: 'JohnDoe' } as User); // an "as" assertion, to have types for all properties
  const user = await UserModel.findById(id).exec();

  console.log(user); // prints { _id: 59218f686409d670a97e53e0, name: 'JohnDoe', __v: 0 }
})();

Motivation

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.

Instead of:

interface Car {
  model?: string;
}

interface Job {
  title?: string;
  position?: string;
}

interface User {
  name?: string;
  age: number;
  job?: Job;
  car: Car | string;
}

mongoose.model('User', {
  name: String,
  age: { type: Number, required: true },
  job: {
    title: String;
    position: String;
  },
  car: { type: Schema.Types.ObjectId, ref: 'Car' }
});

mongoose.model('Car', {
  model: string,
});

You can just:

class Job {
  @prop()
  public title?: string;

  @prop()
  public position?: string;
}

class Car {
  @prop()
  public model?: string;
}

class User {
  @prop()
  public name?: string;

  @prop({ required: true })
  public age!: number;

  @prop()
  public job?: Job;

  @prop({ ref: Car })
  public car?: Ref<Car>;
}

---

Requirements

• TypeScript 3.7+
• Node 8.10+
• mongoose ^5.7.7
• emitDecoratorMetadata and experimentalDecorators must be enabled in tsconfig.json

Install

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

Testing

npm run test Run our tests after running npm i -D

Versioning

Major.Minor.Fix (or how npm expresses it Major.Minor.Patch)
(This Project should comply with Semver)

Join Our Discord Server

To ask questions or just talk with us join our Discord Server

Documentation

Here is the Documentation
Here are Guides

Migrate to 6.0.0

Migrate to 6.0.0

Known Issues

Here are the known-issues

FAQ

Here is the FAQ

Notes

• Please dont add comments with +1 or something like that, use the Reactions
• npm run doc generates all documentation for all files that can be used as modules (is used for github-pages)
• npm run doc:all generates documentation even for internal modules

Changelog

6.1.0

• Update Dependencies
  • Upgrade mongoose from 5.7.1 to 5.7.7
  • [IC] Upgrade Typescript from 3.6.x to 3.7.2
• Completely remove @staticMethod & @instanceMethod, because they were completely obsolete
• README now has no documentation anymore
• @prop({ validate }) now accepts { validator, message } as an array
• Add function deleteModel & deleteModelWithClass
• allow Prop Option "type" to overwrite the inferred type look here for an example
• integrate "Array Validators & Transform" tests typegoose#29
• adding global options, with setGlobalOptions
• add modelOption runSyncIndexes
• add modelOption allowMixed
• add text to PropOptions
• deprecate ArrayPropOptions's itemsRef, itemsRefPath & itemsRefType
• DocumentType will now overwrite the type of _id if the class is extending Base (in TypeScript there is currently no other way)
• add tslib as dependency to minimize generated code
• fixing typo in (deprecated) setModelForClass
• Remake how Enums are handled, use setGlobalOptions({ globalOptions: { useNewEnum: true } }) (to not break existing databases made with the old handling)
• add function getModelWithString
• [IC] tsconfig: add option "strictBindCallApply"
• [IC] tsconfig: add option "strictFunctionTypes"
• [IC] combine initAsObject and initAsArray into initProperty
• [IC] Use internal "isNullOrUndefined", needed because all "util.is*" functions got deprecated in node 4.0.0
• [IC] Replace all "isArray" with "Array.isArray", needed because all "util.is*" functions got deprecated in node 4.0.0
• [IC] adding many sanity isNullOrUndefined checks
• [IC] Re-done how the handling of Mixed is done
• [IC] Re-done how IModelOptions are merged (thanks to lodash cloneDeepWith & mergeWith)
• [IC] de-duplicate "ref" & "refPath" code
• [IC] added test for "Custom Types"
• [IC] typegoose now makes use of "importHelpers"(tsconfig) to save some space
• [IC] Refactor how "isPrimitive" works, some types like Buffer & Decimal now work
• [IC] Added more debug logs to prop.ts
• [IC] Move Decorator Cache to the class itself
• [IC] "baseProp" now uses one single arguments, with all the options
• [IC] "createUniqueID" now returns a boolean instead of the "initname"