@types/mongoose

What is @types/mongoose?

@types/mongoose provides TypeScript type definitions for the Mongoose library, which is an Object Data Modeling (ODM) library for MongoDB and Node.js. These type definitions help developers write type-safe code when using Mongoose with TypeScript.

What are @types/mongoose's main functionalities?

Schema Definition

Defines a Mongoose schema with TypeScript interfaces to ensure type safety. The IUser interface extends Document, which is a Mongoose type representing a MongoDB document.

const mongoose = require('mongoose');
import { Schema, Document, model } from 'mongoose';

interface IUser extends Document {
  name: string;
  email: string;
  age: number;
}

const UserSchema: Schema = new Schema({
  name: { type: String, required: true },
  email: { type: String, required: true },
  age: { type: Number, required: true }
});

const User = model<IUser>('User', UserSchema);

Model Methods

Uses the User model to find a document in the MongoDB collection. TypeScript ensures that the user object conforms to the IUser interface.

User.findOne({ email: '[e-mail]' }, (err, user) => {
  if (err) throw err;
  if (user) {
    console.log(user.name);
  }
});

Custom Methods

Adds a custom method to the Mongoose schema and ensures type safety with TypeScript. The getFullName method is defined in the IUser interface and implemented in the schema.

interface IUser extends Document {
  name: string;
  email: string;
  age: number;
  getFullName(): string;
}

UserSchema.methods.getFullName = function(): string {
  return this.name;
};

const User = model<IUser>('User', UserSchema);

User.findOne({ email: '[e-mail]' }, (err, user) => {
  if (err) throw err;
  if (user) {
    console.log(user.getFullName());
  }
});

Other packages similar to @types/mongoose

@types/sequelize

@types/sequelize provides TypeScript type definitions for Sequelize, which is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite, and Microsoft SQL Server. It offers similar functionalities to Mongoose but is used for SQL databases instead of MongoDB.

README

Installation

npm install --save @types/mongoose

Summary

This package contains type definitions for Mongoose ( http://mongoosejs.com/ ).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mongoose

Additional Details

• Last updated: Wed, 10 Apr 2019 17:33:40 GMT
• Dependencies: @types/mongodb, @types/node
• Global values: none

Credits

These definitions were written by horiuchi https://github.com/horiuchi, lukasz-zak https://github.com/lukasz-zak, Alorel https://github.com/Alorel, jendrikw https://github.com/jendrikw, Ethan Resnick https://github.com/ethanresnick, vologa https://github.com/vologab, jussikinnula https://github.com/jussikinnula, ondratra https://github.com/ondratra, alfirin https://github.com/alfirin, Idan Dardikman https://github.com/idandrd, Dominik Heigl https://github.com/various89, Fazendaaa https://github.com/Fazendaaa, Norman Perrin https://github.com/NormanPerrin, Dan Manastireanu https://github.com/danmana, stablio https://github.com/stablio, Emmanuel Gautier https://github.com/emmanuelgautier, Frontend Monster https://github.com/frontendmonster, Ming Chen https://github.com/mingchen, Olga Isakova https://github.com/penumbra1, Orblazer https://github.com/orblazer, HughKu https://github.com/HughKu, Erik Lopez https://github.com/niuware.