Odtnhj

How do I setup Typegoose for a NodeJs REST API and typescript?

I always get weird error messages like MongoParseError: Incomplete key value pair for option or I do not receive any data, although there are some.

Can someone provide a complete example ?

If you want to programm an API under the following conditions, you can use the provided minimal example below:

Conditions:

NodeJS
Typescript
MongoDB (locally)

Example:

If you are working with typescript, a project structure, similar to this is recommended:

├── dist
| ├── (your compiled JS)
├── src
| ├── models
| | ├── user.model.ts
| ├── user-repository.ts
| ├── app.ts
| ├── index.ts
├── test
| ├── (your tests)

Furthermore, it's required to install the following packages

npm install --save typescript mongoose express @types/express @types/mongoose typegoose

index.ts:

This file, I just have for bootstraping purposes

import app from './app';

const port = 3000;

app.listen(port, (err) => 
 if (err) 
 return console.log(err);
 
 return console.log('Server up and running on ' + port);
);

app.ts:

Here, the actual logic is going on

import UserRepository from './user-repository';
import * as express from 'express';

export class App 
 public app;

 constructor() 
 this.app = express();
 this.config();
 this.mountRoutes();
 

 private mountRoutes() 
 // Definition of the possible API routes
 this.app.route('/users')
 .get((req, res) => 
 var repo = new UserRepository();
 // we catch the result with the typical "then"
 repo.getUsers().then((x) => 
 // .json(x) instead of .send(x) should also be okay
 res.status(200).send(x);
 );
 );

 // here with parameter
 // 


export default new App().app;

user-repository.ts

import * as mongoose from 'mongoose';
import User, UserModel from './models/user.model';


export class UserRepository 
 constructor() 

 async getUser(id: number): Promise<User> 
 // json query object as usual
 // 

 async getUsers(): Promise<User> 
 return UserModel.find();
 

user.model.ts

import * as mongoose from 'mongoose';
import prop, Typegoose from 'typegoose';


export class User extends Typegoose
 // v
 @prop()
 userId: number;
 @prop()
 firstname?: string;
 @prop()
 lastname: string;
 @prop()
 email: string;


export const UserModel = new User().getModelForClass(User, 
 // v
 schemaOptions: collection: 'users'
)

As obvious, I had a mongodb running locally, having a database called mongotest and inside that a collection called users.