@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 needs to be enhanced with special Typegoose decorators (like @prop).

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.9+
• Node 10.15+
• mongoose ^5.9.14
• experimentalDecorators and emitDecoratorMetadata must be enabled in tsconfig.json

Note: it is recommended to not use babel see here why

Install

npm i -s @typegoose/typegoose # install typegoose itself

npm i -s mongoose # install peer-dependencie mongoose
npm i -D @types/mongoose # install all types for mongoose - this is required for typegoose to work in typescript

Testing

npm i -D
npm test

Versioning

This Project should comply with Semver. It uses the Major.Minor.Fix standard (or in NPM terms, Major.Minor.Patch).

Join Our Discord Server

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

Documentation

• Typegoose Documentation
• Quick start guide

Migrate to 6.0.0

Migrate to 6.0.0

Known Issues

Here are the known-issues

FAQ

Here is the FAQ

Notes

• Please don't add +1 or similar comments to issues. Use the reactions instead.
• npm run doc generates all documentation for all files that can be used as modules (and is used for GitHub Pages)
• npm run doc:all generates documentation even for internal modules

Changelog

7.1.1

• Remove empty interface PropOptions
• Remove type PropOptionsWithValidate
• Rename type PropOptionsWithNumberValidate to PropOptionsForNumber
• Rename type PropOptionsWithStringValidate to PropOptionsForString
• Add options options & match for VirtualOptions
• Add option enum for ValidateNumberOptions
• arrayProp & mapProp are now just an alias for prop
• Set TSDoc option @deprecated for arrayProp and mapProp
• Detect mongoose.Types.Array & mongoose.Schema.Types.Array as Array in @prop
• Detect mongoose.Types.Map & mongoose.Schema.Types.Map as Map in @prop
• Add Overloads to @prop
• PascalCased decorators now have the TSDoc of the original function
• Default class Base's __v & __t are now optional (with ?)
• Fix mentioned bug from typegoose#181, to allow mongoose.Schema.Types.String & mongoose.Schema.Types.Number as valid enum types
• Options of & items are now mapped to type and get called when buildSchema is called
• [IC] DeDuplicate code in prop.ts